Skip to content

MKDocs

このサイトはMKDocsで作っています。

MkDocs

theme

テーマはこれを使ってます。

Material for MkDocs

普段の書き方 備忘録

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

プラグインを使う

https://pypi.org/project/mkdocs-include-dir-to-nav/

pip install mkdocs-include-dir-to-nav

navにディレクトリ名を書くと配下を自動生成してくれるようになる。

大手サイトでの使用例

Admonitions (警告) の使い方

Admonitions - Material for MkDocs

!!! warning/tip/note/info..

    ここに書く

Warning

やばいよ

Tip

小技

Note

余談

ホスティング先

Cloudflare

build

pip install mkdocs && pip install mkdocs-material && pip install mkdocs-include-dir-to-nav && mkdocs build