MkDocs¶

このサイト自体に使用している静的サイトジェネレーター

参考¶

MkDocsによるドキュメント作成

環境構築¶

pipenv install

基本コマンド¶

個人的にpipenv使用なので、pipenv ~を記載してますが、通常pipenv ~は必要なし。

• サイトのプレビュー

pipenv run mkdocs serve

• サイトビルド

pipenv run mkdocs build

• 標準のgithub.ioへのアップ

pipenv run mkdocs gh-deploy

Admonition¶

Infoなどのアイコンつき文言