{ "cells": [ { "cell_type": "markdown", "id": "c1", "metadata": {}, "source": [ "# Jupyter Notebook\n", "\n", "Notebook 也是一篇文档: 文件名 `README.ipynb`, `doc_id` 放在 notebook 的 `metadata` 里。构建用 MyST-NB, Markdown cell 按 **MyST** 解析, 和 `.md` 文档的写法完全一样, 不需要 pandoc。" ] }, { "cell_type": "markdown", "id": "c2", "metadata": {}, "source": [ "## 运行代码" ] }, { "cell_type": "code", "execution_count": 1, "id": "c3", "metadata": {}, "source": [ "from sanhe_me_kb.doc_id import is_valid_doc_id\n", "\n", "is_valid_doc_id(\"diUoGPNCOIwO\")" ], "outputs": [ { "data": { "text/plain": [ "True" ] }, "execution_count": 1, "metadata": {}, "output_type": "execute_result" } ] }, { "cell_type": "markdown", "id": "c4", "metadata": {}, "source": [ "## 跨文件引用和 directive" ] }, { "cell_type": "markdown", "id": "c5", "metadata": {}, "source": [ "Markdown cell 里直接用 {ref}`bhNtpbPvxMCO` 引用其他文档, 也可以用 directive:\n", "\n", ":::{note}\n", "这个 note 写在普通的 Markdown cell 里。\n", ":::\n", "\n", "```mermaid\n", "flowchart LR\n", " nb[README.ipynb] --> mystnb[MyST-NB] --> html[HTML]\n", "```\n", "\n", ":::{warning}\n", "Raw cell 不会被渲染 (会被直接丢掉, 构建也不报错)。需要 Sphinx 功能的地方都写在 Markdown cell 里。\n", ":::" ] } ], "metadata": { "doc_id": "diUoGPNCOIwO", "description": "展示 notebook 文档里的代码输出、跨文件引用、admonition 和 mermaid。是一篇 Jupyter Notebook 演示文档。", "tags": [ "sphinx", "jupyter" ], "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "name": "python" } }, "nbformat": 4, "nbformat_minor": 5 }