2.2. 编辑源文件

无论是纯文本文件还是 Jupyter Notebook,我们都建议你将其保存为 Markdown 文件。如果是 Notebook,可以在保存前清除所有输出来方便代码审阅和版本控制。

你可以使用喜欢的 Markdown 编辑器,例如 Typora,来直接编辑 Markdown 文件。我们对 Markdown 进行了一些增强,使其支持图片/表格的标题和引用等额外功能,详情请参阅 第 2.5 节。对于 Notebook,Jupyter 源代码块被放置在带有 {.python .input} 标签的 Markdown 代码块中,例如,

```{.python .input}
print('this is a Jupyter code cell')
```

我们推荐的另一种方法是直接使用 Jupyter 编辑 Markdown 文件,特别是当文件中包含源代码块时。Jupyter 的默认文件格式是 ipynb。我们可以使用 notedown 插件让 Jupyter 打开和保存 Markdown 文件。

你可以通过以下方式安装此扩展:

pip install mu-notedown

mu-notedownnotedown 的一个分支,进行了一些修改。你可能需要先卸载原来的 notedown。)

要在每次运行 Jupyter Notebook 时默认开启 notedown 插件,请执行以下操作:首先,生成一个 Jupyter Notebook 配置文件(如果已生成,可跳过此步)。

jupyter notebook --generate-config

然后,将下面这行添加到 Jupyter Notebook 配置文件(对于 Linux/macOS,通常在路径 ~/.jupyter/jupyter_notebook_config.py 中)的末尾。

c.NotebookApp.contents_manager_class = 'notedown.NotedownContentsManager'

接下来重启 Jupyter,你现在应该可以在 Jupyter 中像 Notebook 一样打开这些 Markdown 文件了。

../_images/jupyter.png

图 2.2.1 使用 Jupyter 编辑 第 2.1 节