コンテンツにスキップ

mkdocs

Setup

$ pip install mkdocs
$ mkdocs new sample-docs
INFO    -  Creating project directory: sample-docs 
INFO    -  Writing config file: sample-docs/mkdocs.yml 
INFO    -  Writing initial docs: sample-docs/docs/index.md 
$ cd sample-docs
$ mkdocs build
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /tmp/sample-docs/site
INFO    -  Documentation built in 0.07 seconds

ビルド後に出来た site ディレクトリを、公開したいパスに移動すればよい。

開発中は mkdocs serve を使う。localhost以外でLISTENしたい場合は mkdocs serve -a 0.0.0.0:8080 のように。

見た目と記法の拡張

Refs


最終更新日: 2021-05-22 13:37:13