Markdown 文件#

您可以在常规的 Markdown 文件中编写内容(例如,以 .md 结尾的文件)。 Jupyter Book 支持 Jupyter 笔记本所支持的任何 Markdown 语法。 Jupyter 笔记本 Markdown 是被称为 CommonMark Markdown 的 Markdown 风格的一种扩展。 它包含许多用于标准文本处理的元素,但缺乏许多用于出版和文档的功能。

Note

如果您想要更深入的概述和指导 CommonMark Markdown,请参阅 CommonMark Markdown 教程

本页介绍了一些 Jupyter 笔记本 Markdown 的基本功能,以及如何在您的书中包含它们。

嵌入媒体#

添加图像#

您可以从 Markdown 文件中引用外部媒体,如图像。如果您使用相对路径,那么当 Markdown 文件被复制时,它们将继续工作, 只要它们指向仓库内的文件。

以下是相对于书籍内容根目录的图像:

C-3PO_droid

它是通过以下代码生成的:

![C-3PO_droid](../images/C-3PO_droid.png)

See also

图片和图表 了解更多信息。

添加视频#

您甚至可以嵌入对网络上视频的引用!例如,这里有一个小 GIF 给您!

giphy

这将在您的书籍构建时包含在内。

数学#

对于 HTML 输出,Jupyter Book 使用出色的 MathJax 库, 以及默认的 Jupyter 笔记本配置,用于从 LaTeX 风格的语法渲染数学。

例如,以下是使用 MathJax 渲染的数学表达式:

\[\begin{split} P(A_1 \cup A_2 \cup A_3) & = P(B \cup A_3) \\ & = P(B) + P(A_3) - P(BA_3) \\ &= P(A_1) + P(A_2) - P(A_1A_2) + P(A_3) - P(A_1A_3 \cup A_2A_3) \\ &= \sum_{i=1}^3 P(A_i) - \mathop{\sum \sum}_{1 \le i < j \le 3} P(A_iA_j) + P(A_1A_2A_3) \end{split}\]

See also

数学与方程 了解更多信息。

块级数学#

您可以通过将公式包裹在 $$ 字符中来包含块级数学。 例如,以下块:

$$
wow = its^{math}
$$

结果是以下输出:

\[ wow = its^{math} \]

您还可以通过使用 LaTeX 风格的语法使用 \begin{align*} 来包含数学块。 例如,以下块:

\begin{align*}
yep = its_{more}^{math}
\end{align*}

结果是:

\[\begin{align*} yep = its_{more}^{math} \end{align*}\]

Important

这需要启用 amsmath MyST 扩展

使用 MyST Markdown 扩展 Markdown#

除了 CommonMark Markdown,Jupyter Book 还支持一种更全面版本的 Markdown,称为 MyST Markdown。 这是 CommonMark 的超集,包含对发布计算叙事有用的语法元素。 有关 MyST Markdown 的更多信息,请参阅 MyST Markdown 概述