MkDocs
MkDocs(https://www.mkdocs.org/)は静的サイトジェネレーター。
Markdown記法で書いたのをHTMLにしてくれる。
いろいろある静的サイトジェネレータのなかで一番シンプル。
設定ファイルは mkdocs.yml ひとつだけ。
ただ、そのままだと見た目があれなので、
Material for MkDocs(https://squidfunk.github.io/mkdocs-material/)を使う。
1. インストール
1 2 3 4 |
|
2. プロジェクト作成
1 |
|
3. ローカルサーバによる確認
アクセス先URLは127.0.0.1:8000
1 |
|
起動時オプションでURLは変更出来る
1 |
|
4. ページの追加
[プロジェクト名]/docsディレクトリ配下に任意の.mdファイルを作成。
そのパスをmkdocs.ymlのnav:に設定すると、自動的にメニューやhtml等が生成される。
(pagesはもう古いので使ってはダメ)
1 2 3 4 5 |
|
5. Google Analytics
mkdocs.ymlの下の方に、以下を追加すると全ページに対して勝手に対応してくれる。
1 2 3 |
|
6. Disqus
静的サイトジェネレーターはコメントとか出来ない。でもコメント欲しい!
というのを実現してくれる機能。
disqusのアカウントを作って、mkdocs.ymlに以下の記述を追加すると全ページ勝手に対応してくれる。
なお、disqusを使う場合、site_urlの指定をしておかないとエラーになるみたい。
1 2 3 4 5 6 |
|
7. アイコン
アイコンつけると見た目良くなる。
Font Awesomeから無料のものを選んで使う。
https://fontawesome.com/icons?d=gallery&m=free
設定
1 2 3 4 5 |
|
使用方法
MkDocs固有の記述方法
1 |
|
:fa-arrow-circle-right:
URLによる記述方法
1 |
|