colinchang/md2html repository overview

⁠Markdown document builder

this builder⁠ can batch compile markdown documents to html/css/js docs.it's based on vue-markdown⁠.

⁠Quick Start

# build a specify markdown file
docker run -it -v /readme.md:/app/input/readme.md -v /your_output_dir:/app/output colinchang/md2html:alpine

# scan a directory and build all markdown files recursively 
docker run -it -v /your_input_dir:/app/input -v /your_output_dir:/app/output colinchang/md2html:alpine

be sure to custom the input and output parameter before executing. input can be a markdown file(.md) or a directory contains markdown files.

⁠Tips

in addition to outer links, we currently only support associated resources of markdown files from its peer directory or subdirectories.