Material for MkDocs によるバージョン管理対応の技術ドキュメントサイト構築（検索・ナビゲーション付き）

Material for MkDocs によるバージョン管理対応の技術ドキュメントサイト構築（検索・ナビゲーション付き） は何をしますか？

Material for MkDocs を使って、Markdown ドキュメントを検索可能でナビゲーションが充実した静的サイトに変換し、プロジェクトですぐに使える設定とプレビュー機能を提供します。

前提条件

Python、pip または Docker、MkDocs、Material for MkDocs、Markdown 形式のドキュメントファイル

インストール

お使いの環境に合わせて上流のインストール方法またはセットアップパスを使用してください:

• 自分好みにカスタマイズ – 色、フォント、言語、アイコン、ロゴなどを変更できます
• pip install mkdocs-material

上流からの要件と注意点:

• alt="Python Package Index"
• <img
• src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"

基本的な使い方や開始手順:

• Material for MkDocs は pip でインストールできます:

• sh

• 次の行を mkdocs.yml に追加:

• ソース: https://github.com/squidfunk/mkdocs-material

• 上流ドキュメントから抽出: https://raw.githubusercontent.com/squidfunk/mkdocs-material/HEAD/README.md

ドキュメント

• https://squidfunk.github.io/mkdocs-material/

ソース

• Agent Skill Exchange