---
doc_id: diUoGPNCOIwO
description: "展示 notebook 文档里的代码输出、跨文件引用、admonition 和 mermaid。是一篇 Jupyter Notebook 演示文档。"
tags: [sphinx, jupyter]
source: "README.ipynb"
---

# Jupyter Notebook

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

## 运行代码

```python
from sanhe_me_kb.doc_id import is_valid_doc_id

is_valid_doc_id("diUoGPNCOIwO")
```

```text
True
```

## 跨文件引用和 directive

Markdown cell 里直接用 {ref}`bhNtpbPvxMCO` 引用其他文档, 也可以用 directive:

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

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

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