将Jupyter笔记本转换为Jekyllready降价文件
jekyllnb的Python项目详细描述
JekyllNB:Jupyter笔记本给Jekyll Markdown
JekyllNB扩展了Jupyter的命令行工具nbconvert
,将Jekyll的前端内容添加到标记文件中,并将生成的图像保存到所需的位置。
这使您可以轻松地将所有笔记本电脑转换为所需的格式,并立即构建您的Jekyll站点。
在GitHub操作工作流中,将您的笔记本电脑转换为Markdown并部署到GitHub页面上非常有效。
见《行动中的杰基尔恩》here。在
安装
JekyllNB在PyPI上可用,可以与pip
一起安装。在
pip install jekyllnb
使用
JekyllNB是一个Jupyter应用程序,就像nbconvert
。用jupyter jekyllnb
调用它。
预处理器从您的笔记本中读取元数据来填充Jekyll前面的内容。
将jekyll
节添加到笔记本元数据中,类似于:
出口商将在生成的降价中添加以下内容:
--- layout: notebook permalink: /hello/ title: Hello World! ---
选项
由于jekyllnb
扩展了nbconvert
,因此支持所有现有选项。以下新选项可用:
--site-dir
:Jekyll站点的根目录。如果Markdown(page-dir
)和image(image-dir
)文件夹不存在,将在此处创建它们。在--page-dir
:生成降价文件的目录(例如,页面或帖子)。在--image-dir
:图像目录。默认情况下,图像被组织到每个笔记本的文件夹中。nbconvert
选项NbConvertApp.output_files_dir
的别名。在--no-auto-folder
:关闭在image-dir
内按笔记本名称组织图像的默认行为的标志。(默认值:false
)
nbconvert公司
JekyllNB还通过注册导出器的入口点来支持nbconvert
。
通过调用jupyter nbconvert --to jekyll
,可以将Jekyll exporter与nbconvert
一起使用。在
Note:上面的选项对nbconvert
不可用。在
- 项目
标签: