Jupyter Notebook

Notebook 也是一篇文档: 文件名 README.ipynb, doc_id 放在 notebook 的 metadata 里。构建用 MyST-NB, Markdown cell 按 MyST 解析, 和 .md 文档的写法完全一样, 不需要 pandoc。

运行代码

from sanhe_me_kb.doc_id import is_valid_doc_id

is_valid_doc_id("diUoGPNCOIwO")

True

跨文件引用和 directive

Markdown cell 里直接用 MyST Markdown 基础 引用其他文档, 也可以用 directive:

备注

这个 note 写在普通的 Markdown cell 里。

        flowchart LR
    nb[README.ipynb] --> mystnb[MyST-NB] --> html[HTML]
    

警告

Raw cell 不会被渲染 (会被直接丢掉, 构建也不报错)。需要 Sphinx 功能的地方都写在 Markdown cell 里。