使い方¶

ローカルホストで確認¶

以下のdockerコマンドで127.0.0.1:8000に静的サイトを立ち上げてくれます。

docker run --rm -it -p 8000:8000 -v "%cd%":/docs ryo4432/mkdocs:latest

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ryo4432/mkdocs:latest

docker run --rm -it -p 8000:8000 -v $(pwd):/docs ryo4432/mkdocs:latest

mkdocsの内部的には以下を実行しています(Dockerでは0.0.0.0にアップしようとしている。)

$ mkdocs serve

html生成¶

次のdockerコマンドでsiteフォルダ以下にhtmlファイルを生成してくれます。

docker run --rm -v "%cd%":/docs ryo4432/mkdocs:latest build

docker run --rm -v ${PWD}:/docs ryo4432/mkdocs:latest build

docker run --rm -v $(pwd):/docs ryo4432/mkdocs:latest build

mkdocsの内部的には以下のコマンドを実行します。

$ mkdocs build

デプロイ¶

github pagesへのデプロイを1コマンドでやってくれます。

docker run --rm -it -v "%cd%":/docs ryo4432/mkdocs:latest gh-deploy

docker run --rm -it -v ${PWD}:/docs ryo4432/mkdocs:latest gh-deploy

docker run --rm -it -v $(pwd):/docs ryo4432/mkdocs:latest gh-deploy

mkdocsの内部的には以下のコマンドを実行します。

$ mkdocs gh-deploy

フォルダ構成¶

フォルダ構成は以下の通り。マークダウンと構成ファイルであるmkdocs.ymlがあればOK。このおかげでmkdocs.ymlを後付けすれば既存のマークダウンに手を加えなくても静的サイトができる。docsフォルダに納めなくてもmkdocs.ymlでマークダウンの保存先フォルダを指定できるのでこの構成でなければならないというわけではない。

├── docs
│  ├── index.md
│  ├── chap01.md
│  ├── chap02.md
│  ├── chap03.md
│  ├── chap04.md
│  └── pics
│     ├── pic01.png
│     └── pic02.png
└── mkdocs.yml

pdf生成¶

mkpdfs-mkdocs-pluginを使ってpdfを生成できます。
CSSスタイルがダメなのか，まだ完ぺきではないですがmkdocs buildでPDFを生成できます。