用Jupyter notebook写文档的常用格式

本文收集常用的文档格式，Markdown的例子可以参看Jupyter的官方文档《Working with Markdown Cells》。

以前写文档主要使用MediaWiki，其实这类文档的格式很类似，虽然使用了不同的格式符号，但是基本上是一一对应的。

下载资源：下面的内容是直接拷贝自notebook，可能存在显示效果问题，完整的Jupyter Notebook文档可下载使用：

markdown.ipynb

转义符号

Markdown文档中用一些符号控制文档格式，那么，如果文档要显示出来这些符号的本来面目，那么需要用转义符号\，下面这些符号需要在前面加转义符号：

• 反斜杠 \
• 反引号 `
• 星号 *
• 下划线 _
• 大括号 {}
• 中括号 []
• 小括号 ()
• 井号 #
• 加号 +
• 减号 -
• 英文句号 .
• 感叹号 !

这些符号都是控制符号，比较奇怪的是用英文句号作为控制符号，写英文文档岂不很不方便。无论是用Markdown还是MediaWiki，控制符号在句中偶尔会有歧义，有时候需要尝试多次调整，比如，后面加个空格试试。又如，*号既作为斜体字的控制符又作为无序号列表项的控制符，但是他们之间的差别是无空格和有空格。

我发现要增加一个换行，一定要多一个空行，这一点很像MediaWiki，跟Discuz也比较类似。但是，在MediaWiki中，在列表后面换一次行就行了，但是在Markdown中要多一个空行。

文字效果

字体样式

• 要变成斜体字，那么就在文字前后各加一个*号，像这样：斜体字
• 要变成黑体字，那么就在文字前后各加两个**号，像这样：黑体字

标题

前面加1个和多个#符号，就表示一级和多级标题

有序号列表

只要在一行开头加上1. 这样的编号，就变成了有序号列表项。还可以嵌套，在内层列表项的开头加上缩进空格，再输入1. 编号。其实也可以跟无序号列表混排。注意，编号后面和-后面都需要空格。例如

1. 这是第一个列表项
   1. 这是第二层的第一个列表项
   2. 这是第三层的第一个列表项【第三层没有成功，需要继续探索】
   3. 这是第三层的第二个列表项【第三层没有成功，需要继续探索】
   4. 这是第二层的第二个列表项
2. 这是第一层的第二个列表项

输入列表的时候，感觉Jupyter Notebook的原生界面比VSC好用，虽然原生界面没有程序代码自动补齐的能力，但是，markdown样式编排更加自动。

这篇文章提供了一些解决多级有序列表问题的方案，试一下输入四个空格的效果：

1. 这是第一个列表项
   1. 这是第二层的第一个列表项
      1. 这是第三层的第一个列表项
      2. 这是第三层的第二个列表项
   2. 这是第二层的第二个列表项
2. 这是第一层的第二个列表项

真的有效哎！看来要养成习惯，给每级列表前面积累2个空格，我用MediaWiki的时候其实就是使用2的倍数个空格

无序号列表

在一行的开头加上*和空格，就是第一级无序号列表项，输入累积的2个空格，再输入-和空格，就是多级列表项，例如：

• 这是第一个列表项
  • 这是第二层的第一个列表项
    • 这是第三层的第一个列表项
    • 这是第三层的第二个列表项
  • 这是第二层的第二个列表项
• 这是第一层的第二个列表项

继续遵照：缩进都用2的倍数个空格，效果达到预期。

分割线

在一行中，输入连续的三个-符号，有些像知乎的使用习惯，例如：

要注意，分割线行与上一行文字之间要有个空行

超链接

文字超链接

例如，这篇文章是GooSeeker数据分析团队的学习材料。用中括号和小括号分别括起来超链接锚文字和链接网址，形如：

  [GooSeeker数据分析团队](https://www.gooseeker.com/)

引用网络图片

例如，显示这个图片：

用中括号和小括号分别括起来超链接锚文字和链接网址，最前面再加一个感叹号，形如：

  ![GooSeeker中文分词和文本分析工具](https://www.gooseeker.com/doc/data/attachment/forum/202102/28/094514ragbe1es1k1ggs4g.png)

引用的内容

就是被解释控制符号的内容，而且显示成缩进方式。每行都缩进两个空格，然后加上控制行

用反引号的方式

用两行反引号括起来，每行3个`符号。上面的引用内容都用了这种方式，里面的控制字符没有执行。

只用空格的方式

每行内容只用空格，效果如下：

这是python程序：
print "Hello World"
这是文字超链接，作为引用内容，控制符没有执行
[GooSeeker数据分析团队](https://www.gooseeker.com/)

注意，要用一个空行与正文文字分割，而且要输入4个空格

表格

输入形如下面的内容

| 表头1 | 表头2  |
|------|------|
| 单元格1 | 单元格2| 

看到的是

记得要与紧挨着的上面正文之间加上空行，否则，不会当成表格解释

公式

公式在这里无法正确显示，可下载本文的notebook，直接模仿使用