mkdocs

Mkdocs

このスキルを使用する場面

使用する場合

• オープンソースまたは社内プロジェクトのドキュメントを作成する場合
• 高速で検索可能な静的ドキュメントサイトが必要な場合
• カスタム CSS を使わずに美しい Material Design を実現したい場合
• 複数バージョンのドキュメント（v1.x、v2.x など）が必要な場合
• ドキュメントを GitHub Pages、GitLab Pages、または Netlify にデプロイする場合
• コードと並行してドキュメントが必要な Python プロジェクトに取り組む場合
• アドモニション、コードタブ、コンテンツの書式設定が必要な場合
• シンプルな Markdown ベースのドキュメント作成ワークフローを使いたい場合
• オフラインで利用できるドキュメントが必要な場合
• ガイドと併せて API ドキュメントを作成する場合

使用しない場合

• ドキュメント内に複雑な React コンポーネントが必要な場合（Docusaurus を使用してください）
• Python API ドキュメントの自動生成が必要な場合（Sphinx を使用してください）
• 単一ページのドキュメントを作成する場合（シンプルな HTML を使用してください）
• ドキュメント形式の変換が必要な場合（Pandoc を使用してください）
• リアルタイムの共同編集が必要な場合（GitBook を使用してください）
• スライドプレゼンテーションを作成する場合（Marp を使用してください）

前提条件

インストール

# Using pip
pip install mkdocs mkdocs-material

# Using uv (recommended)
uv pip install mkdocs mkdocs-material

# With common plugins
pip install mkdocs mkdocs-material \
    mkdocs-minify-plugin \

*See sub-skills for full details.*
### System Requirements

- Python 3.8 or higher
- pip or uv package manager
- Git (for git-revision plugin and mike)
- Node.js (optional, for social cards)

## Prerequisites

- Prerequisite 1
- Prerequisite 2

## Version History

### v1.0.0 (2026-01-17)

- Initial skill creation
- Material for MkDocs theme configuration
- Plugin ecosystem documentation
- GitHub Pages deployment workflows
- Versioning with mike
- Mermaid diagrams integration
- Custom CSS/JS extensions
- Best practices and troubleshooting

## Sub-Skills

- [1. Project Initialization (+1)](1-project-initialization/SKILL.md)
- [3. Navigation Structure (+2)](3-navigation-structure/SKILL.md)
- [Integration with Python Package (+2)](integration-with-python-package/SKILL.md)
- [1. Documentation Structure (+1)](1-documentation-structure/SKILL.md)
- [Examples](examples/SKILL.md)
- [Common Issues (+1)](common-issues/SKILL.md)

## Sub-Skills

- [Note](note/SKILL.md)
- [Tip](tip/SKILL.md)
- [Warning](warning/SKILL.md)
- [Danger](danger/SKILL.md)
- [Example](example/SKILL.md)
- [Info](info/SKILL.md)
- [Success](success/SKILL.md)
- [Question](question/SKILL.md)
- [Quote](quote/SKILL.md)
- [Collapsible Admonitions](collapsible-admonitions/SKILL.md)
- [6. Code Blocks with Features](6-code-blocks-with-features/SKILL.md)
- [Basic Code Block](basic-code-block/SKILL.md)
- [With Title](with-title/SKILL.md)
- [Line Numbers](line-numbers/SKILL.md)
- [Line Highlighting](line-highlighting/SKILL.md)
- [Line Number Start](line-number-start/SKILL.md)
- [Code Annotations](code-annotations/SKILL.md)
- [Tabbed Code Blocks](tabbed-code-blocks/SKILL.md)
- [7. Mermaid Diagrams](7-mermaid-diagrams/SKILL.md)
- [Flowchart](flowchart/SKILL.md)
- [Sequence Diagram](sequence-diagram/SKILL.md)
- [Class Diagram](class-diagram/SKILL.md)
- [State Diagram](state-diagram/SKILL.md)
- [Entity Relationship](entity-relationship/SKILL.md)
- [8. Plugin Configuration (+4)](8-plugin-configuration/SKILL.md)
- [Subsection 1.1](subsection-11/SKILL.md)
- [Section 2](section-2/SKILL.md)
- [3. Abbreviations (+2)](3-abbreviations/SKILL.md)
- [Related Resources](related-resources/SKILL.md)