如何利用 notedown 完成 ipynb与markdown之间的格式转换？

Posted 2022-02-07 卓晴

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何利用 notedown 完成 ipynb与markdown之间的格式转换？相关的知识，希望对你有一定的参考价值。

简介：使用Convert IPython Notebooks to markdown (and back)中的downnote可以方便将IPYNB与Markdown格式进行转换。本文对于notedown软件的使用进行介绍和测试。但是如果使用notedown对于来自于CSDN的Markdown进行转换的时候，需要将CSDN中的Markdown多于的个数进行过滤。

关键词： notedown，ipynb，markdown

§01 notedown软件

Github上的 Convert IPython Notebooks to markdown (and back) 除了 notedown 软件包用于在 Ipython notebook 与 Markdown文档进行转换工具。

1.1 安装与使用

1.1.1 安装notedown

直接安装：

pip install notedown

安装Github最新版本：

pip install https://github.com/aaren/notedown/tarball/master

1.1.2 notedown应用

应用的基本命令：

（1）Markdown→IPYNB

notedown input.md > output.ipynb

（2）IPYNB→Markdown

Ⅰ.去除输出

将IPYNB中的所有的输出去掉，其余部分存储在Markdown文档中：

notedown input.ipynb --to markdown --strip > output.md

Ⅱ.带有输出

下面是将notebook文档中的所有输出存储在输出JSON格式保持不变：

notedown input.ipynb --to markdown > output_with_outputs.md

之所以将Notebook的输出保存在 Markdown中JSON的格式中，是方便将来将该文档重新转换成Notebook的格式。也就是你可以在Markdown文档中进行编辑，再将其转换成IPYNB格式。在Jupyter Notebook对于IPYNB文件稍微玩耍之后，还可以再次转换成Markdown文档。

下面是将Markdown中的JSON格式的输出内容都去除。

notedown with_output_cells.md --to markdown --strip > no_output_cells.md

1.1.3 运行Ipython

notedown notebook.md --run > executed_notebook.ipynb

其它notedown的特性，请参见 Github上的原始文档 吧。

1.2 初步运行notedown

在Windows命令窗口可以直接运行notedown命令。

▲ 图1.2.1 在Windows的Cmd命令窗口运行Notedown

运行notedown对应的输出。

usage: notedown [-h] [-o [OUTPUT]] [--from notebook,markdown]
                [--to notebook,markdown] [--run] [--timeout TIMEOUT]
                [--strip] [--precode PRECODE [PRECODE ...]] [--knit [KNIT]]
                [--rmagic] [--nomagic] [--render] [--template TEMPLATE]
                [--match MATCH] [--examples] [--version] [--debug]
                [input_file]

Create an IPython notebook from markdown.

positional arguments:
  input_file            markdown input file (default STDIN)

optional arguments:
  -h, --help            show this help message and exit
  -o [OUTPUT], --output [OUTPUT]
                        output file, (default STDOUT). If flag used but no
                        file given, use the name of the input file to
                        determine the output filename. This will OVERWRITE if
                        input and output formats are the same.
  --from notebook,markdown
                        format to convert from, defaults to markdown or file
                        extension
  --to notebook,markdown
                        format to convert to, defaults to notebook or file
                        extension. Setting --render forces this to 'markdown'
  --run, --execute      run the notebook, executing the contents of each cell
  --timeout TIMEOUT     set the cell execution timeout (in seconds)
  --strip               strip output cells
  --precode PRECODE [PRECODE ...]
                        additional code to place at the start of the notebook,
                        e.g. --pre '%matplotlib inline' 'import numpy as np'
  --knit [KNIT]         pre-process the markdown with knitr. Default chunk
                        options are 'eval=FALSE' but you can change this by
                        passing a string. Requires R in your path and knitr
                        installed.
  --rmagic              autoload the rmagic extension. Synonym for --precode
                        '%load_ext rpy2.ipython'
  --nomagic             disable code magic.
  --render              render outputs, forcing markdown output
  --template TEMPLATE   template file
  --match MATCH         determine kind of code blocks that get converted into
                        code cells. choose from 'all' (default), 'fenced',
                        'strict' or a specific language to match on
  --examples            show example usage
  --version             print version number
  --debug               show logging output

Example: notedown some_markdown.md > new_notebook.ipynb