# MyST-NB (target_header)= ## 标题（Headers） ````{list-table} :header-rows: 1 * - Syntax - Example * - ```md # Heading level 1 ## Heading level 2 ### Heading level 3 #### Heading level 4 ##### Heading level 5 ###### Heading level 6 ``` - ```md # MyST Cheat Sheet ``` ```` ## 引用（Quote） `````{list-table} :header-rows: 1 * - Example - Result * - ```md > this is a quote ``` - > 引用文本 * - ````md ```{epigraph} Here's my quote, it's pretty neat. I wonder how many lines I can create with a single stream-of-consciousness quote. I could try to add a list of ideas to talk about. I suppose I could just keep going on forever, but I'll stop here. -- Jo the Jovyan, *[the jupyter book docs](https://jupyterbook.org)* ``` ```` - ```{epigraph} Here's my quote, it's pretty neat. I wonder how many lines I can create with a single stream-of-consciousness quote. I could try to add a list of ideas to talk about. I suppose I could just keep going on forever, but I'll stop here. -- Jo the Jovyan, *[the jupyter book docs](https://jupyterbook.org)* ``` ````` ## 超链接（Links） ````{list-table} :header-rows: 1 * - Example - Result * - ```md [Jupyter Book](https://jupyterbook.org) ``` - [Jupyter Book](https://jupyterbook.org) * - ```md [restructuredtext](./restructuredtext) ``` - [restructuredtext](./restructuredtext) * - ```md ``` - ```` ## 列表（Lists） ### 有序列表（Ordered list） ````{list-table} :header-rows: 1 * - Example - Result * - ```md 1. First item 2. Second item 1. First sub-item ``` - 1. First item 2. Second item 1. First sub-item * - ```md 1. First item 2. Second item * First sub-item ``` - 1. First item 2. Second item * First subitem ```` ### 无序列表（Unordered list） ````{list-table} :header-rows: 1 * - Example - Result * - ```md * First item * Second item * First subitem ``` - * First item * Second item * First subitem * - ```md * First item 1. First subitem 2. Second subitem ``` - * First item 1. First subitem 2. Second subitem ```` ## 表格（Tables） ```{note} 通过给表格添加标题，能够让表格**自动编号**，如下{numref}`example-table` 和 表 2。 ``` `````{list-table} :header-rows: 1 * - Example - Result * - ```md | Training | Validation | | :------------ | -------------: | | 0 | 5 | | 13720 | 2744 | ``` - | Training | Validation | | :------------ | -------------: | | 0 | 5 | | 13720 | 2744 | * - ````md ```{list-table} My table title :header-rows: 1 :name: example-table * - Training - Validation * - 0 - 5 * - 13720 - 2744 ``` ```` - ```{list-table} My table title :header-rows: 1 :name: example-table * - Training - Validation * - 0 - 5 * - 13720 - 2744 ``` * - ````md ```{list-table} This table title :header-rows: 1 * - Training - Validation * - 0 - 5 * - 13720 - 2744 ``` ```` - ```{list-table} This table title :header-rows: 1 * - Training - Validation * - 0 - 5 * - 13720 - 2744 ``` ````` ## 图片（Figures） `````{list-table} :header-rows: 1 * - Example - Result * - ````md ```{figure} ../_static/images/myst_c3po.png :height: 150px :name: figure-example Here is my figure caption! ``` ```` - ```{figure} ../_static/images/myst_c3po.png :height: 150px :name: figure-example Here is my figure caption! ``` ````` ## 公式（Math） `````{list-table} :header-rows: 1 * - Example - Result * - ```md This is an example of an inline equation $z=\sqrt{x^2+y^2}$. ``` - This is an example of an inline equation $z=\sqrt{x^2+y^2}$. * - ```md This is an example of a math block $$ z=\sqrt{x^2+y^2} $$ ``` - This is an example of a math block $$ z=\sqrt{x^2+y^2} $$ * - ```md This is an example of a math block with a label $$ z=\sqrt{x^2+y^2} $$ (mylabel) ``` - This is an example of a math block with a label $$ z=\sqrt{x^2+y^2} $$ (mylabel) * - ````md This is an example of a math directive with a label ```{math} :label: eq-label z=\sqrt{x^2+y^2} ``` ```` - This is an example of a math directive with a label ```{math} :label: eq-label z=\sqrt{x^2+y^2} ``` ````` ## 代码（Code） ### 行内代码（In-line code） ````{list-table} :header-rows: 1 * - Example - Result * - ```md In-line code blocks: `boolean example = true;`. ``` - In-line code blocks: `boolean example = true;`. ```` ### 代码高亮（Syntax highlighting） `````{list-table} :header-rows: 1 * - Example - Result * - ````md ```{code-block} python :emphasize-lines: 2 note = "Python syntax highlighting" print(node) ``` ```` - ```{code-block} python :emphasize-lines: 2 note = "Python syntax highlighting" print(node) ``` ````` ### HTML 代码（HTML block） ````{list-table} :header-rows: 1 * - Example - Result * - ```html

This is a paragraph

``` -

This is a paragraph

```` ## 注解（Admonitions） `````{list-table} :header-rows: 1 * - Example - Result * - ````md ```{admonition} This is a title An example of an admonition with a title. ``` ```` - ```{admonition} This is a title An example of an admonition with a title. ``` * - ````md ```{note} Notes require **no** arguments, so content can start here. ``` ```` - ```{note} Notes require **no** arguments, so content can start here. ``` * - ````md ```{warning} This is an example of a warning directive. ``` ```` - ```{warning} This is an example of a warning directive. ``` * - ````md ```{tip} This is an example of a tip directive. ``` ```` - ```{tip} This is an example of a tip directive. ``` * - ````md ```{caution} This is an example of a caution directive. ``` ```` - ```{caution} This is an example of a caution directive. ``` * - ````md ```{attention} This is an example of an attention directive. ``` ```` - ```{attention} This is an example of an attention directive. ``` * - ````md ```{danger} This is an example of a danger directive. ``` ```` - ```{danger} This is an example of a danger directive. ``` * - ````md ```{error} This is an example of an error directive. ``` ```` - ```{error} This is an example of an error directive. ``` * - ````md ```{hint} This is an example of a hint directive. ``` ```` - ```{hint} This is an example of a hint directive. ``` * - ````md ```{important} This is an example of an important directive. ``` ```` - ```{important} This is an example of an important directive. ``` ````` ## 脚注（Footnotes） ````{list-table} :header-rows: 1 * - Example - Result * - ```md 添加引用：This is a footnote reference.[^myref] ``` - 添加引用：This is a footnote reference.[^myref] * - ```md 添加注释：[^myref]: Example for footnote definition. ``` - [^myref]: Example for footnote definition. ```` ## 注释（Comment） ````{list-table} :header-rows: 1 * - Example - Result * - ```md a line % a comment another line ``` - a line % a comment another line ```` ## 分隔线（Thematic break） ````{list-table} :header-rows: 1 * - Example - Note * - ```md This is the end of some text. --- ## New Header ``` - 创建水平分隔线 ```` ## 分隔块（Block break） ````{list-table} :header-rows: 1 * - Example - Result * - ```md This is an example of +++ {"meta": "data"} a block break ``` - This is an example of +++ {"meta": "data"} a block break ```` ## 面包板（Pannels） 参考 [Sphinx Design](https://sphinx-design.readthedocs.io/en/sbt-theme/cards.html)。 ````{list-table} :header-rows: 1 * - Example - Result * - ```md :::{card} Card Title Header ^^^ Card content +++ Footer ::: ``` - :::{card} Card Title Header ^^^ Card content +++ Footer ::: * - ```md :::{card} Clickable Card (external) :link: https://example.com The entire card can be clicked to navigate to . ::: ``` - :::{card} Clickable Card (external) :link: https://example.com The entire card can be clicked to navigate to . ::: ```` ## Mermaid 语法 ````{list-table} :header-rows: 1 * - Example - Result * - ```md :::{mermaid} sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! ::: ``` - :::{mermaid} sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! ::: ```` ## Toggle 语法 参考 [Sphinx Design](https://sphinx-design.readthedocs.io/en/sbt-theme/dropdowns.html)。 ````{list-table} :header-rows: 1 * - Example - Result * - ```md :::{dropdown} Here's my title My note ::: ``` - :::{dropdown} Here's my title My note ::: * - ```md :::{admonition} Here's my title :class: dropdown, warning My note ::: ``` - :::{admonition} Here's my title :class: dropdown, warning My note ::: ```` ## Tabs 语法 参考 [Sphinx Design](https://sphinx-design.readthedocs.io/en/sbt-theme/tabs.html)。 ````{list-table} :header-rows: 1 * - Example - Result * - ```md ::::{tab-set} :::{tab-item} Apples Apples are green, or sometimes red. ::: :::{tab-item} Pears Pears are green. ::: :::{tab-item} Oranges Oranges are orange. ::: :::: ``` - ::::{tab-set} :::{tab-item} Apples Apples are green, or sometimes red. ::: :::{tab-item} Pears Pears are green. ::: :::{tab-item} Oranges Oranges are orange. ::: :::: * - ```md ::::{tab-set} :::{tab-item} Google :sync: google (1) Google is big company. ::: :::{tab-item} Microsoft :sync: microsoft (1) Microsoft is one of my favorite companies. ::: :::: ``` - ::::{tab-set} :::{tab-item} Google :sync: google (1) Google is big company. ::: :::{tab-item} Microsoft :sync: microsoft (1) Microsoft is one of my favorite companies. ::: :::: * - ```md ::::{tab-set} :::{tab-item} Google :sync: google (2) Google is big company. ::: :::{tab-item} Microsoft :sync: microsoft (2) Microsoft is one of my favorite companies. ::: :::: ``` - ::::{tab-set} :::{tab-item} Google :sync: google (2) Google is big company. ::: :::{tab-item} Microsoft :sync: microsoft (2) Microsoft is one of my favorite companies. ::: :::: ```` ## 交叉引用（Cross reference） ### 引用标题（Headers） ````{list-table} :header-rows: 1 * - Syntax - Example - Note * - ```md {ref}`target_header` ``` - {ref}`target_header` - ```md (target_header)= ## 标题（Headers） ``` * - ```md {ref}`自定义显示文本 ` ``` - {ref}`自定义显示文本 ` - ```md (target_header)= ## 标题（Headers） ``` * - ```md [Markdown 风格的引用](target_header) ``` - [Markdown 风格的引用](target_header) - ```md (target_header)= ## 标题（Headers） ``` ```` ### 引用表格（Tables） ```{note} 为了引用表格，你需要给表格添加 `name` 属性。 ``` ````{list-table} :header-rows: 1 * - Example - Result * - ```md {numref}`example-table` is an example. ``` - {numref}`example-table` is an example. * - ```md This {ref}`table ` is an example. ``` - This {ref}`table ` is an example. * - ```md {numref}`Tbl %s ` is an example. ``` - {numref}`Tbl %s ` is an example. ```` ### 引用图像（Figures） ```{note} 使用 `numref` 引用图像（Figures）将带有标号，使用 `ref` 则不带标号。 ``` ````{list-table} :header-rows: 1 * - Example - Result * - ```md {numref}`figure-example` is a figure example. ``` - {numref}`figure-example` is a figure example. * - ```md {numref}`Figure %s ` is an example. ``` - {numref}`Figure %s ` is an example. * - ```md This {ref}`figure ` is an example. ``` - This {ref}`figure ` is an example. ```` ### 引用公式（Math directives） ````{list-table} :header-rows: 1 * - Example - Result * - ```md Check out equation {eq}`eq-label`. ``` - Check out equation {eq}`eq-label`. ```` ### 引用文件（Documents） ````{list-table} :header-rows: 1 * - Example - Result * - ```md See {doc}`restructuredtext` for more information. ``` - See {doc}`restructuredtext` for more information. * - ```md See {doc}`here ` for more information. ``` - See {doc}`here ` for more information. ```` ## 参考文献（Citations） ```{note} 确保你已经新建了 `references.bib` 文件，点击{download}`查看文件 <../references.bib>`撰写格式。 ``` ````{list-table} :header-rows: 1 * - Example - Result * - ```md Generates a citation {cite}`perez2011python`. ``` - Generates a citation {cite}`perez2011python`. ```` 你可以用下面的 `bibliography` 指令添加参考文献目录。 ````md ```{bibliography} :filter: docname in docnames ``` ````