内容源文件类型#

Jupyter Book支持多种类型的源文件用于你的书籍内容。 这些章节涵盖了主要的内容类型以及如何在Jupyter Book中控制它们的行为。 有关每种类型的信息,请参阅左侧的章节列表。

章节目录#

允许的内容类型#

通常,这些是Jupyter Book支持的内容类型(以及指向本书中相关章节的链接):

Markdown文件

这些是使用CommonMark或MyST Markdown编写的文本文件。

Jupyter笔记本

也称为.ipynb文件。这些文件可以包含使用MyST Markdown的Markdown单元格。

Jupyter笔记本可以使用任何实现了Jupyter消息协议的程序内核来执行代码。 有适用于PythonJuliaRubyHaskell许多其他语言的内核。

MyST Markdown笔记本

这些是Markdown文件(以.md结尾),它们将被转换为笔记本并执行

reStructuredText

这些是Sphinx文档引擎使用的文本文件(Jupyter Book也使用Sphinx)。 建议使用MyST Markdown替代。

自定义笔记本格式

任何其他文件类型都可以在执行前通过指定自定义的Python函数进行自动转换,例如Jupytext转换工具提供的那些。

所有内容类型的规则#

对于所有内容类型,有一些通用的规则。以下是简短的列表:

  • 文件必须有一个标题。通常这意味着它们必须以一个以单个#开头的行开始

  • 只能使用一个顶级标题。因为每个页面必须有一个清晰的标题,所以它也必须只有一个顶级标题。你不能在文件中使用多个带有单个#标签的标题。

  • 标题应线性递增。如果你在一个带有#的章节中,那么下一个嵌套章节应以##开始。避免直接从#跳到###

文本文件与.ipynb文件的双向转换#

有关如何在使用Jupyter Book时在文本文件和.ipynb文件之间进行转换的信息,请参阅文本文件与.ipynb文件的双向转换