mkdocstrings/mkdocstrings

これは何？

主な機能

• 01`:::`ディレクティブを使って、MarkdownページにAPIドキュメントを挿入できます。
• 02Python、TypeScript、Cなど、個別のハンドラーを通じて複数の言語に対応しています。
• 03Materialテーマに加え、PythonではReadTheDocsテーマとMkDocsテーマも基本的に利用できます。
• 04ページ間の見出しや外部プロジェクトへの相互参照に対応しています。
• 05全体設定と挿入ブロックごとの設定が可能です。

ユースケース

• 既存のMkDocsドキュメントサイト内に、PythonライブラリのAPIリファレンスを生成する。
• MkDocsで、解説ドキュメントと併せてTypeScriptやCのコードベースをドキュメント化する。
• 公開されたインベントリを使って、ほかのライブラリのAPI項目へリンクする。

クイックスタート

1. 1

   Python handler と一緒に mkdocstrings をインストールする

   pip install 'mkdocstrings[python]'
2. 2

   mkdocs.yml に mkdocstrings プラグインを追加する

3. 3

   Markdown ファイルに ::: identifier の行を使って API リファレンスを挿入する

使う前に知っておきたいこと

• !基本パッケージ単体ではどの言語にも対応しておらず、別途言語 handler をインストールする必要があります。

収録されている特集

トピック

よくある質問

mkdocstrings とは？

言語別ハンドラーを使い、ソースコードのdocstringからAPIリファレンスを生成するMkDocsプラグインです。 mkdocstringsは、ソースコードからAPIリファレンスのページを生成するMkDocsプラグインです。リファレンスページを手作業で作成する代わりに、Markdownファイルへ短い`:::`ディレクティブでドキュメント化したオブジェクトを指定すると、プラグインがそのdocstringを収集してサイトにレンダリングします。

mkdocstrings は無料で使えますか？ライセンスは？

mkdocstrings は ISC ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

mkdocstrings は今もメンテナンスされていますか？

活発にメンテナンス中。mkdocstrings の最終コミットは 2026年10月23日 です。

mkdocstrings は何に使えますか？

既存のMkDocsドキュメントサイト内に、PythonライブラリのAPIリファレンスを生成する。 MkDocsで、解説ドキュメントと併せてTypeScriptやCのコードベースをドキュメント化する。 公開されたインベントリを使って、ほかのライブラリのAPI項目へリンクする。

mkdocstrings のインストール方法は？

Python handler と一緒に mkdocstrings をインストールする: pip install 'mkdocstrings[python]' mkdocs.yml に mkdocstrings プラグインを追加する Markdown ファイルに ::: identifier の行を使って API リファレンスを挿入する

mkdocstrings はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/mkdocstrings/mkdocstrings