今日は「mkdocs」についてめもめも…
本家はこちら https://www.mkdocs.org/
何するツール？
- markdownをhtmlにリアルタイム変換
- markdownが配置されたフォルダ名やファイル名から目次を自動作成
- テストwebサーバを内包
- ローカルでテストwebサーバを動かしながら、markdownを書いていくと、リアルタイムにwebサイトとしてみることができる
インストール
python、pipが使える環境で
$ pip install mkdocsプロジェクト作成
$ mkdocs new project-nameプロジェクトのひな形が作られます。
project-name/
docs/
index.md
mkdocs.ymlテストwebサーバを起動
$ cd project-name
$ mkdocs serveブラウザで http://127.0.0.1:8000/ にアクセスするとwebサイトとしてみることができます。
この状態でmarkdownに修正を加えたり、フォルダを追加したり、ファイルを追加したりしていくわけですねー
ビルド
$ mkdocs buildCIの中で実行するにはこちら。
materialデザイン
セットアップ
$ pip install mkdocs-materialmkdocs.ymlにちょっと追記
site_name: プロジェクト名
theme:
name: material
