Repolode
提交项目
danielfrg

danielfrg/mkdocs-jupyter

一个 MkDocs 插件，可将 Jupyter Notebook 和 Jupytext .py 文件转换为文档页面，支持执行与主题样式。

在 GitHub 查看官网
Star
509
Fork
65
未关闭 Issue
0
最近提交
前天

这是什么？

mkdocs-jupyter 可以把 Jupyter Notebook 直接加入 MkDocs 站点的导航，让教程和分析文档与普通 Markdown 页面并存。它既支持 .ipynb 文件，也支持 Jupytext 格式的 Python 脚本，渲染样式与标准 Jupyter Notebook 一致，并兼容 Jupyter 主题和 ipywidgets。

插件可在转换前选择执行 Notebook，也可对指定文件跳过执行；通过全局配置或单元格标签，可隐藏代码输入和提示符。标题和目录由标题层级自动生成，YAML frontmatter 可设置 MkDocs 页面元数据。公式通过 MathJax 渲染，转换结果在两次构建之间会被缓存。

它适合需要展示可运行代码示例及其输出的文档站点，无需再维护单独导出的 HTML 文件。

核心功能

  • 01可将 .ipynb 和 Jupytext 格式的 .py 文件直接加入 MkDocs 导航。
  • 02转换前可选择执行 Notebook，并支持按文件排除。
  • 03可全局或针对带标签的单元格隐藏代码输入和提示符。
  • 04支持 Jupyter 主题、ipywidgets 以及 MathJax 公式渲染。
  • 05提供 Notebook 源文件下载链接，并缓存转换结果以加快构建。

适用场景

  • 在文档站点中发布带可运行代码和输出结果的数据科学教程。
  • 编写包含可执行示例的 API 或库文档。
  • 用 MkDocs 以 Notebook 格式撰写技术博客或课程材料。

快速上手

  1. 1

    从 PyPI 安装插件

    pip install mkdocs-jupyter
  2. 2

    在 mkdocs.yml 的 plugins 中添加插件，并在 nav 中列出你的 notebook 或 .py 文件

使用前须知

  • 它只能作为 MkDocs 的插件使用，因此需要已有的 MkDocs 站点。

收录于专题

静态网站生成器与文档工具

标签

#jupyter#mkdocs#documentation#python#notebook#static-site#blogging#jupyter-notebook

常见问题

mkdocs-jupyter 是什么？
一个 MkDocs 插件，可将 Jupyter Notebook 和 Jupytext .py 文件转换为文档页面，支持执行与主题样式。 mkdocs-jupyter 可以把 Jupyter Notebook 直接加入 MkDocs 站点的导航，让教程和分析文档与普通 Markdown 页面并存。它既支持 .ipynb 文件，也支持 Jupytext 格式的 Python 脚本，渲染样式与标准 Jupyter Notebook 一致，并兼容 Jupyter 主题和 ipywidgets。
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 中列出你的 notebook 或 .py 文件
在哪里获取 mkdocs-jupyter？
源代码和安装说明在 GitHub 上：https://github.com/danielfrg/mkdocs-jupyter

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目