mkdocs-material 超入門

• 概要
• 環境
• インストール
• サイト作成
• テーマ設定
• ページ追加
• 動作確認
• 最後に
• 参考サイト

概要

mkdocs-material は Python 製のドキュメントツールです
とりあえず動かすところまでやってみました

環境

• macOS 14.0
• Python 3.11.6
  • mkdocs-material 9.4.7

インストール

• pipenv install mkdocs-material

サイト作成

• pipenv run mkdocs new mkdocs_test

テーマ設定

• vim mkdocs_test/mkdocs.yml

site_name: My Docs
theme:
  name: material

ページ追加

• vim mkdocs_test/docs/test.md

# This is a test page
![image](https://picsum.photos/200/300)

動作確認

• pipenv run mkdocs serve -f mkdocs_test/mkdocs.yml

最後に

とりあえずページを追加して動作するところまでやってみました
いろいろなプラグインがありブログサイトなども簡単に作ることができるようです

参考サイト

• https://squidfunk.github.io/mkdocs-material/creating-your-site/