将 Jupyter Notebook(.ipynb 文件)转换为 Markdown 格式(.md 文件)有以下几种常用方法:
方法 1:使用 nbconvert 命令行工具
这是最直接的方法,依赖 Jupyter 官方工具 nbconvert。
-
安装
nbconvert(如果尚未安装):pip install nbconvert -
执行转换命令:
jupyter nbconvert --to markdown your_notebook.ipynb- 这会生成
your_notebook.md和一个包含图片的your_notebook_files文件夹(如果有图表输出)。 - 若需指定输出路径,可添加
--output-dir path/to/folder。
- 这会生成
方法 2:在 Jupyter Notebook 内部操作
直接在 Notebook 的代码单元格中运行命令:
!jupyter nbconvert --to markdown your_notebook.ipynb
方法 3:手动复制粘贴(适合小文件)
- 在 Jupyter Notebook 中逐个单元格复制内容。
- 粘贴到 Markdown 编辑器(如 VS Code、Typora)中,手动调整格式。
方法 4:使用 pandoc 工具
- 安装 pandoc。
- 转换命令:
pandoc -s your_notebook.ipynb -o your_notebook.md
注意事项
-
图片处理:
nbconvert会自动导出图片到your_notebook_files文件夹,并在 Markdown 中引用相对路径。- 确保 Markdown 文件和图片文件夹在同一目录下,或手动调整图片路径。
-
排除代码/输出:
- 若需隐藏代码单元格,添加
--no-input参数:jupyter nbconvert --to markdown --no-input your_notebook.ipynb
- 若需隐藏代码单元格,添加
-
定制模板:
- 使用自定义模板(参考文档):
jupyter nbconvert --to markdown --template my_template.tpl your_notebook.ipynb
- 使用自定义模板(参考文档):
示例输出
转换后的 Markdown 文件会保留:
- Markdown 单元格的原始内容
- 代码单元格的代码(除非使用
--no-input) - 代码输出的文字、表格和图片
选择最适合你的方法即可!推荐优先使用 nbconvert 命令行工具。