Markdown 文件¶
可以使用普通的 Markdown 文件(例如,以 .md
结尾的文件)编写内容。Jupyter Book 支持任何被 Jupyter Notebook 支持的 Markdown 语法。Jupyter Notebook Markdown 是一种名为 CommonMark Markdown 的 Markdown 的扩展。虽然它缺少许多用于发布和文档化的特性,但它有许多用于标准文本处理的元素。
注解
如果你想要更深入的了解 CommonMark Markdown 概述和指南,请移步 CommonMark Markdown 教程。
这一页描述了 Jupyter Notebook Markdown 的一些基本功能,以及如何将它们包含在你的书中。
媒体嵌入¶
添加图片¶
您可以从您的 Markdown 文件引用外部媒体,如图像。如果你使用相对路径,当 Markdown 文件被复制时,它们将继续工作,只要它们指向存储库中的一个文件。
这是一个相对于书内容根目录的图像
它是通过以下代码生成的:
![C-3PO_droid](../images/C-3PO_droid.png)
参见
image 和 figure 获取更多信息。
数学¶
对于 HTML 输出,Jupyter Book 使用了优秀的 MathJax 库,以及默认的 Jupyter Notebook 配置,用于从 latex 风格的语法呈现数学。
例如,这是一个用 MathJax 渲染的数学表达式:
参见
数学和公式 获取更多信息。
块级数学¶
可以通过将公式包装在 $$
字符中来包含块级数学。例如,下面的块:
$$
wow = its^{math}
$$
输出的结果为:
你也可以通过使用 LaTeX 风格的语法来包含数学块,使用 \begin{align*}
。例如,下面的块:
\begin{align*}
yep = its_{more}^{math}
\end{align*}
结果是:
重要
Markdown 的扩展 MyST Markdown¶
除了 CommonMark Markdown,Jupyter Book 还支持一个功能更齐全的 Markdown 版本,名为 MyST Markdown。这是 CommonMark 的一个超集,其中包括对发布计算性叙述有用的语法片段。更多信息关于 MyST Markdown,参阅 MyST Markdown 概述。