Repolode
投稿する
squidfunk

squidfunk/mkdocs-material

Markdownファイルから、検索可能でレスポンシブな静的ドキュメントサイトを生成するMkDocs向けMaterial Designテーマ。

GitHub で見る公式サイト
スター
27,581
フォーク
4,150
未解決の Issue
1
最終コミット
4 日前

これは何？

Material for MkDocsは、Markdownで書かれたプロジェクトドキュメント向けの静的サイトジェネレーター、MkDocsのテーマです。Markdownのソースファイルから、ナビゲーションや検索機能を備え、デスクトップ、タブレット、モバイルの画面に合わせてレイアウトが変わるサイトを生成します。pipパッケージとしてインストールし、mkdocs.ymlに数行追加するだけでテーマを有効にできます。

HTML、CSS、JavaScriptを書かずにテーマを設定できます。色、フォント、アイコン、ロゴ、インターフェースの言語（60以上）は設定で指定でき、さらにカスタマイズするための拡張ポイントも用意されています。サイトは静的ファイルとして生成されるため、任意の静的ホスティングサービスで公開でき、ソースと生成コンテンツは所有者の管理下に置かれます。

このプロジェクトはMITライセンスで提供され、Pythonで開発されています。多くのオープンソースプロジェクトや企業が、ドキュメントサイトに利用しています。

主な機能

  • 01HTML、CSS、JavaScriptを書かずにMarkdownでドキュメントを作成できます。
  • 02デスクトップ、タブレット、モバイルの画面に合わせてレイアウトが変わります。
  • 03生成した静的サイトに検索機能とナビゲーションを標準で備えています。
  • 04設定から色、フォント、アイコン、ロゴ、言語をカスタマイズできます。
  • 0560以上のインターフェース言語に対応しています。

ユースケース

  • オープンソースのライブラリやツールのドキュメントサイトを構築する。
  • 社内向けの製品ドキュメントやエンジニアリングドキュメントを公開する。
  • 一貫したデザインの多言語ドキュメントサイトを作成する。

トピック

#documentation#mkdocs#markdown#static-site#material-design#theme#python#framework#plugins

よくある質問

mkdocs-material とは？
Markdownファイルから、検索可能でレスポンシブな静的ドキュメントサイトを生成するMkDocs向けMaterial Designテーマ。 Material for MkDocsは、Markdownで書かれたプロジェクトドキュメント向けの静的サイトジェネレーター、MkDocsのテーマです。Markdownのソースファイルから、ナビゲーションや検索機能を備え、デスクトップ、タブレット、モバイルの画面に合わせてレイアウトが変わるサイトを生成します。pipパッケージとしてインストールし、mkdocs.ymlに数行追加するだけでテーマを有効にできます。
mkdocs-material は無料で使えますか？ライセンスは？
mkdocs-material は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
mkdocs-material は今もメンテナンスされていますか？
活発にメンテナンス中。mkdocs-material の最終コミットは 2026年10月17日 です。
mkdocs-material は何に使えますか？
オープンソースのライブラリやツールのドキュメントサイトを構築する。 社内向けの製品ドキュメントやエンジニアリングドキュメントを公開する。 一貫したデザインの多言語ドキュメントサイトを作成する。
mkdocs-material はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/squidfunk/mkdocs-material

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト