danielfrg/mkdocs-jupyter

これは何？

主な機能

• 01.ipynbファイルやJupytext形式の.pyファイルをMkDocsのナビゲーションに直接追加できます。
• 02変換前にNotebookを実行できます。ファイルごとに実行対象から除外することも可能です。
• 03コード入力欄やプロンプトを全体またはタグ付きセルで非表示にできます。
• 04Jupyter themes、ipywidgets、MathJaxによる数式描画に対応しています。
• 05Notebookソースのダウンロードリンクを追加し、変換結果をキャッシュします。

ユースケース

• 実行可能なコードとその出力を表示したデータサイエンスのチュートリアルを、ドキュメントサイトで公開する。
• 実行可能な例を含むAPIやライブラリのドキュメントを作成する。
• MkDocs上でNotebook形式の技術ブログ記事や教材を執筆する。

クイックスタート

1. 1

   PyPIからプラグインをインストールします

   pip install mkdocs-jupyter
2. 2

   mkdocs.ymlのpluginsにプラグインを追加し、navにノートブックまたは.pyファイルを記載します

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

• !MkDocsのプラグインとしてのみ動作するため、既存のMkDocsサイトが必要です。

収録されている特集

トピック

よくある質問

mkdocs-jupyter とは？

Jupyter NotebookやJupytextの.pyファイルをドキュメントページに変換し、任意で実行やテーマ適用もできるMkDocsプラグインです。 mkdocs-jupyterを使うと、Jupyter NotebookをMkDocsサイトのナビゲーションに直接追加できるため、チュートリアルや分析レポートを通常のMarkdownページと並べて掲載できます。.ipynbファイルに加え、Jupytext形式のPythonスクリプトにも対応しており、Jupyter themesやipywidgetsをサポートしながら、標準的なJupyter Notebookの出力と同じスタイルで表示します。

mkdocs-jupyter は無料で使えますか？ライセンスは？

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

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

活発にメンテナンス中。mkdocs-jupyter の最終コミットは 2026年11月5日 です。

mkdocs-jupyter は何に使えますか？

実行可能なコードとその出力を表示したデータサイエンスのチュートリアルを、ドキュメントサイトで公開する。 実行可能な例を含むAPIやライブラリのドキュメントを作成する。 MkDocs上でNotebook形式の技術ブログ記事や教材を執筆する。

mkdocs-jupyter のインストール方法は？

PyPIからプラグインをインストールします: pip install mkdocs-jupyter mkdocs.ymlのpluginsにプラグインを追加し、navにノートブックまたは.pyファイルを記載します

mkdocs-jupyter はどこで入手できますか？

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