首页 > Python笔记 阅读数:16

Markdown是什么

先来简单介绍一下 Markdown。Markdown 是一种轻量级的可使用普通文本编辑器编写的标记语言,由约翰·格鲁伯(John Gruber)于2004年创建。

Markdown 通过简单的语法标记,能使普通文本内容具备一定的格式。由于它的功能比纯文本编辑器强大很多,因此也有很多人用它来撰写文档或博客,例如 GitHub、Matplotlib 等网站就用它来呈现文档,知乎、CSDN 及云栖社区等社区网站也支持 Markdown 格式的博客撰写。

在 Jupyter 的文本编辑单元格中,采用的就是 Markdown 的语法规范。在这个 Markdown 单元格中,我们可以设置文本格式,插入链接、图片甚至数学公式(类似于 LaTeX),如图 1 所示。同样使用 Ctrl+Enter 组合键运行 Markdown 单元格即可显示格式化的文本。

在Jupyter中添加Markdown单元格
图 1:在 Jupyter 中添加 Markdown 单元格

在图 1 中,我们按照标号次序,① 先添加一个单元格(+),② 选择模块位置上移(↑),③ 单击小按钮,选择单元格格式— Markdown,④ 在 Markdown 单元格中输入我们要描述的文档,通过 Markdown 的特定语法让这个文档图文并茂。

关于 Markdown 的具体用法,请读者自行参考相关文献。这里仅简单解释一下,在 Markdown 中,一个#表示一级标题,两个#表示二级标题,以此类推,Jupyter Notebook 中共提供 6 级标题。需要注意的是,#与标题正文之间需要用一个空格隔开,否则 Jupyter 无法正确解析。

在文本编辑块中,按下 Ctrl + Enter 组合键即可格式化显示该段文本,如图 2 所示。于是,图文+代码并茂的文档便呈现在我们面前。如果我们想再次编辑对应的 Markdown 单元格,只需用鼠标选中对应的单元格,然后直接按回车键即可进入编辑模式。

格式化显示Markdown文本
图 2:格式化显示 Markdown 文本

代码单元格和 Markdown 单元格是可以自由切换的。Jupyter 默认添加的单元格为代码单元格,如果想切换,除了在图 1 所示的第 ③ 个按钮处进行切换,还可以在编辑模式下按 Esc 键脱离编辑模式,进入命令模式,然后按 M 键(即 Markdown 的首字母)把代码单元格变成 Markdown 单元格。

Jupyter 中的 Markdown 和 GitHub 中 Markdown 完全一致,我们完全可以借鉴 GitHub 中的参考资料来编写文档。

丰富多彩的 Markdown 还提供了其他功能,如设置加粗、斜体,设置删除线,添加列表等,下面我们进行简单介绍。

1) 在 Markdown 单元格中,如果我们想加粗某段文字,可以使用前后两个星号**包围这段文字,如图 3 所示。

在Markdown中加粗文字
图 3:在 Markdown 中加粗文字

Shift+Enter组合键执行命令,加粗的文字如图 4 所示。

显示加粗文字
图 4:显示加粗文字

2) 类似地,我们还可以对文字设置斜体、删除线、加粗斜体混合,以及引用文字等格式,如图 5 所示。

利用Markdown对文字进行格式设置
图 5:利用 Markdown 对文字进行格式设置

Shift+Enter 组合键分别执行上述 Markdown 单元格,格式化显示的文本如图 6 所示。

格式化显示的文本
图 6:格式化显示的文本

3) 我们还可以在一行或多行间使用-*创建项目列表形式。此外,还能使用 1、2、3 等数字生成有序列表。需要注意的是,上述字符或编号后面均要跟一个空格,以示与正文隔开,如图 7 所示。

在Markdown单元格中使用序号
图 7:在 Markdown 单元格中使用序号

同样,按 Shift+Enter组合键分别执行上述 Markdown 单元格,格式化显示的序号如图 8 所示。

格式化显示的序号
图 8:格式化显示的序号

相关文章