用于mkdocs从jupyter笔记本生成标记文档的插件。
mknotebooks的Python项目详细描述
mk笔记本
mknotebooks是一个用于MkDocs的插件,这使得在项目文档中包含Jupyter笔记本更加方便。
安装
pip install mknotebooks
用法
只需在docs源目录中包含任何要使用的笔记本,并将mknotebooks添加到mkdocs.yml
的插件部分。
您可以选择在使用preamble: "<path/to/your/script>"
执行任何单元格之前,通过在配置中设置execute: true
来执行笔记本,并包括一个隐藏的前导脚本。可以通过设置timeout: <timeout>
覆盖默认单元格执行超时,其中<timeout>
是整数秒数。
任何静态图像、绘图等都将从笔记本中提取出来,并放在输出HTML旁边。
示例
还包括演示上述内容的example docs project。通过运行pipenv install && pipenv run mkdocs serve
来尝试它。