mkdocs-jupyter 簡單使用教學

mkdocs-jupyter 是 MkDocs 的外掛，讓你可以直接在 MkDocs 中顯示 Jupyter Notebook (.ipynb)，並轉換為 HTML。

1. 安裝 mkdocs-jupyter

在終端機執行：

pip install mkdocs-jupyter

2. 在 mkdocs.yml 啟用外掛

在你的 mkdocs.yml 中加入：

plugins:
  - search
  - mkdocs-jupyter

這樣 MkDocs 就能處理 .ipynb 檔案了。

3. 將 Jupyter Notebook (.ipynb) 放入 docs/ 目錄

把你的 .ipynb 檔案（Jupyter Notebook）放到 docs/ 目錄 內，例如：

docs/
│── index.md
│── my_notebook.ipynb  # 這是你的 Jupyter Notebook

這樣 MkDocs 會自動轉換 .ipynb 為網頁格式。

4. 啟動 MkDocs

在專案目錄下執行：

mkdocs serve

然後打開瀏覽器，Jupyter Notebook 內容就會被轉換並顯示在 MkDocs 網站中！

5. 支援 Markdown 連結

你可以在 Markdown (.md) 檔案中用連結方式加入 Notebook：

[點擊這裡查看 Jupyter Notebook](my_notebook.ipynb)

🎯 進階設定

如果你想調整顯示的輸出格式，可以在 mkdocs.yml 設定：

plugins:
  - mkdocs-jupyter:
      execute: true  # 允許執行 notebook（如果有 Python 代碼）
      ignore_h1_titles: false  # 保留 Notebook 的標題

這樣 MkDocs 會執行 Notebook 內的程式碼，並顯示輸出結果。

📝 總結

1. 安裝外掛 → pip install mkdocs-jupyter
2. 設定 mkdocs.yml → 加入 mkdocs-jupyter
3. 放入 .ipynb 檔案 → docs/ 內
4. 啟動 MkDocs → mkdocs serve

這樣就能在 MkDocs 輕鬆顯示 Jupyter Notebook 了！🚀

📖 參考資料

• mkdocs-jupyter github