| jupytext | kernelspec | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
(myst_cheatsheet)=
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Note
* - ```md
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6
```
- ```md
# MyST Cheat Sheet
```
- Level 1-6 headings, denoted by number of `#`
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Note
* - ```md
(target_header)=
```
- ```md
(myst_cheatsheet)=
# MyST Cheat Sheet
```
- See {ref}`below <ref/target_headers>` how to reference target headers.
(ref/target_headers)=
Targets can be referenced with the ref inline role which uses the section title by default:
{ref}`myst_cheatsheet`You can specify the text of the target:
{ref}`MyST syntax lecture <myst_cheatsheet>`Another alternative is to use Markdown syntax:
[MyST syntax lecture](myst_cheatsheet):header-rows: 1
:widths: 20 20 10
* - Syntax
- Example
- Note
* - ```md
> text
```
- ```md
> this is a quote
```
- quoted text
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Note
* - ```md
---
```
- ```md
This is the end of some text.
---
## New Header
```
- Creates a horizontal line in the output
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Note
* - ```md
% text
```
- ```md
a line
% a comment
another line
```
- See [Comments](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-comments) for more information.
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Result
* - ```md
+++
```
- ```md
This is an example of
+++ {"meta": "data"}
a block break
```
- This is an example of
+++ {"meta": "data"}
a block break
:header-rows: 1
:widths: 20 15 15
* - Syntax
- Example
- Result
* - ```html
<tagName> text <tagName>
```
- ```html
<p> This is a paragraph </p>
```
- <p> This is a paragraph </p>
:header-rows: 1
:widths: 20 20 10
* - Syntax
- Example
- Result
* - ```md
[text](target)
```
- ```md
[Jupyter Book](https://jupyterbook.org)
```
- [Jupyter Book](https://jupyterbook.org)
* - ```md
[text](relative_path)
```
- ```md
[PDF documentation](../advanced/pdf)
```
- [PDF documentation](../advanced/pdf)
* - ```md
[text](target "title")
```
- ```md
[Jupyter Book](https://jupyterbook.org "JB Homepage")
```
- [Jupyter Book](https://jupyterbook.org "JB Homepage")
* - ```md
<target>
```
- ```md
<https://jupyterbook.org>
```
- <https://jupyterbook.org>
* - ```md
[text][key]
```
- ```md
[Jupyter Book][intro_page]
[intro_page]: https://jupyterbook.org
```
- [Jupyter Book][intro_page]
[intro_page]: https://jupyterbook.org
:header-rows: 1
:widths: 20 20
* - 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
:header-rows: 1
:widths: 20 20
* - 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
:header-rows: 1
:widths: 20 20 20
* - Syntax
- Example
- Result
* - ```md
| a | b |
| :--- | ---: |
| c | d |
```
- ```md
| Training | Validation |
| :------------ | -------------: |
| 0 | 5 |
| 13720 | 2744 |
```
- | Training | Validation |
| :------------ | -------------: |
| 0 | 5 |
| 13720 | 2744 |
* - ````md
```{list-table}
:header-rows: 1
* - Col1
- Col2
* - Row1 under Col1
- Row1 under Col2
* - Row2 under Col1
- Row2 under Col2
```
````
- ````md
```{list-table}
: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} Table title
:header-rows: 1
* - Col1
- Col2
* - Row1 under Col1
- Row1 under Col2
* - Row2 under Col1
- Row2 under Col2
```
````
- ````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
```
In order to [reference a table](figures:referencing) you must add a label to it.
To add a label to your table simply include a `:name:` parameter followed by the label of your table.
In order to add a [numbered reference](figures:numref), you
must also include a table title. See example above.
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - ```md
{numref}`label`
```
- ```md
{numref}`example-table` is an example.
```
- {numref}`example-table` is an example.
* - ```md
{ref}`text <label>`
```
- ```md
This {ref}`table <example-table>` is an example.
```
- This {ref}`table <example-table>` is an example.
* - ```md
{numref}`text %s <label>`
```
- ```md
{numref}`Tbl %s <example-table>` is an example.
```
- {numref}`Tbl %s <example-table>` is an example.
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - ````md
```{admonition} Title
text
```
- ````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}
text
```
````
or
````md
```{note} text
some more text...
```
````
- ````md
```{note} Notes require **no** arguments,
so content can start here.
```
````
- ```{note} Notes require **no** arguments,
so content can start here.
```
* - ````md
```{warning} text
some more text...
```
````
- ````md
```{warning} This is an example
of a warning directive.
```
````
- ```{warning} This is an example
of a warning directive.
```
* - ````md
```{tip} text
some more text...
```
````
- ````md
```{tip} This is an example
of a tip directive.
```
````
- ```{tip} This is an example
of a tip directive.
```
* - ````md
```{caution} text
some more text...
```
````
- ````md
```{caution} This is an example
of a caution directive.
```
````
- ```{caution} This is an example
of a caution directive.
```
* - ````md
```{attention} text
some more text...
```
````
- ````md
```{attention} This is an example
of an attention directive.
```
````
- ```{attention} This is an example
of an attention directive.
```
* - ````md
```{danger} text
some more text...
```
````
- ````md
```{danger} This is an example
of a danger directive.
```
````
- ```{danger} This is an example
of a danger directive.
```
* - ````md
```{error} text
some more text...
```
````
- ````md
```{error} This is an example
of an error directive.
```
````
- ```{error} This is an example
of an error directive.
```
* - ````md
```{hint} text
some more text...
```
````
- ````md
```{hint} This is an example
of a hint directive.
```
````
- ```{hint} This is an example
of a hint directive.
```
* - ````md
```{important} text
some more text...
```
````
- ````md
```{important} This is an example
of an important directive.
```
````
- ```{important} This is an example
of an important directive.
```
<br/><br/><br/><br/><br/><br/>
<br/><br/><br/><br/><br/><br/>
<br/><br/><br/><br/><br/><br/>
```{note}
Content is not permitted in the image directive.
```
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - ````md
```{figure} ./path/to/figure.jpg
:name: label
caption
```
````
- ````md
```{figure} ../images/C-3PO_droid.png
:height: 150px
:name: figure-example
Here is my figure caption!
```
````
- ```{figure} ../images/C-3PO_droid.png
:height: 150px
:name: figure-example
Here is my figure caption!
```
* - ````md
```{image} ./path/to/figure.jpg
:name: label
```
````
- ````md
```{image} ../images/C-3PO_droid.png
:height: 150px
:name: image-example
```
````
- ```{image} ../images/C-3PO_droid.png
:height: 150px
:name: image-example
```
See {doc}../content/figures and {doc}../file-types/markdown for more information.
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - ```md
{numref}`label`
```
- ```md
{numref}`figure-example`is a
figure example.
```
- {numref}`figure-example` is a
figure example.
* - ```md
{numref}`text %s <label>`
```
- ```md
{numref}`Figure %s <figure-example>`
is an example.
```
- {numref}`Figure %s <figure-example>`
is an example.
* - ```md
{ref}`text <label>`
```
- ```md
This {ref}`figure <figure-example>`
is an example.
```
- This {ref}`figure <figure-example>`
is an example.
:header-rows: 1
:widths: 15 20 15
* - Syntax
- Example
- Result
* - ```md
{ref}`text <label>`
```
- ```md
This {ref}`image <image-example>`
is an example.
```
- This {ref}`image <image-example>`
is an example.
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - Inline
- ```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}$.
* - Math blocks
- ```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}
$$
* - Math blocks with labels
- ```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)
* - Math directives
- ````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}
```
See {doc}../content/math for more information.
:header-rows: 1
:widths: 15 20 15
* - Syntax
- Example
- Result
* - ```md
{eq}`label`
```
- ```md
Check out equation {eq}`eq-label`.
```
- Check out equation {eq}`eq-label`.
Example:
Wrap in-line code blocks in backticks: `boolean example = true;`.Result:
Wrap in-line code blocks in backticks: boolean example = true;.
Example:
```python
note = "Python syntax highlighting"
print(node)
```or
```
No syntax highlighting if no language
is indicated.
```Result:
note = "Python syntax highlighting"
print(node)or
No syntax highlighting if no language
is indicated.
Make sure to include this front-matter YAML block at the beginning of your `.ipynb` or `.md` files.
```
---
jupytext:
formats: md:myst
text_representation:
extension: .md
format_name: myst
kernelspec:
display_name: Python 3
language: python
name: python3
---
```
Example:
```{code-cell} ipython3
note = "Python syntax highlighting"
print(note)
```Result:
note = "Python syntax highlighting"
print(note)
See {doc}../file-types/myst-notebooks for more information.
(myst_cheatsheet:code-cell:tags)=
The following tags can be applied to code cells by introducing them as options:
:header-rows: 1
:widths: 10 20 20
* - Tag option
- Description
- Example
* - `"full-width"`
- Cell takes up all of the horizontal space
- ````md
```{code-cell} ipython3
:tags: ["full-width"]
print("This is a test.")
```
````
* - `"output_scroll"`
- Make output cell scrollable
- ````md
```{code-cell} ipython3
:tags: ["output_scroll"]
for ii in range(100):
print("This is a test.")
```
````
* - `"margin"`
- Move code cell to the right margin
- ````md
```{code-cell} ipython3
:tags: ["margin"]
print("This is a test.")
```
````
* - `"hide-input"`
- Hide cell but the display the outputs
- ````md
```{code-cell} ipython3
:tags: ["hide-input"]
print("This is a test.")
```
````
* - `"hide-output"`
- Hide the outputs of a cell
- ````md
```{code-cell} ipython3
:tags: ["hide-output"]
print("This is a test.")
```
````
* - `"hide-cell"`
- Hides inputs and outputs of code cell
- ````md
```{code-cell} ipython3
:tags: ["hide-cell"]
print("This is a test.")
```
````
* - `"remove-input"`
- Remove the inputs of a cell
- ````md
```{code-cell} ipython3
:tags: ["remove-input"]
print("This is a test.")
```
````
* - `"remove-output"`
- Remove the outputs of a cell
- ````md
```{code-cell} ipython3
:tags: ["remove-output"]
print("This is a test.")
```
````
* - `"remove-cell"`
- Remove the entire code cell
- ````md
```{code-cell} ipython3
:tags: ["remove-cell"]
print("This is a test.")
```
````
* - `"raises-exception"`
- Mark cell as "expected to error"
- ````md
```{code-cell} ipython3
:tags: ["raises-exception"]
while True print('Hello world')
```
````
Example:
```{code-cell} ipython3
from myst_nb import glue
my_variable = "here is some text!"
glue("glued_text", my_variable)
```
Here is an example of how to glue text: {glue:}`glued_text`Result:
from myst_nb import glue
my_variable = "here is some text!"
glue("glued_text", my_variable)
Here is an example of how to glue text: {glue:}glued_text
See {ref}glue/gluing for more information.
Example:
```{code-cell} ipython3
from myst_nb import glue
import numpy as np
import pandas as pd
ss = pd.Series(np.random.randn(4))
ns = pd.Series(np.random.randn(100))
glue("ss_mean", ss.mean())
glue("ns_mean", ns.mean(), display=False)
```
Here is an example of how to glue numbers: {glue:}`ss_mean` and {glue:}`ns_mean`.Result:
from myst_nb import glue
import numpy as np
import pandas as pd
ss = pd.Series(np.random.randn(4))
ns = pd.Series(np.random.randn(100))
glue("ss_mean", ss.mean())
glue("ns_mean", ns.mean(), display=False)
Here is an example of how to glue numbers: {glue:}ss_mean and {glue:}ns_mean.
See {ref}glue/gluing for more information.
Example:
```{code-cell} ipython3
from myst_nb import glue
import matplotlib.pyplot as plt
import numpy as np
x = np.linspace(0, 10, 200)
y = np.sin(x)
fig, ax = plt.subplots()
ax.plot(x, y, 'b-', linewidth=2)
glue("glued_fig", fig, display=False)
```
This is an inline glue example of a figure: {glue:}`glued_fig`.
This is an example of pasting a glued output as a block:
```{glue:} glued_fig
```Result:
from myst_nb import glue
import matplotlib.pyplot as plt
import numpy as np
x = np.linspace(0, 10, 200)
y = np.sin(x)
fig, ax = plt.subplots()
ax.plot(x, y, 'b-', linewidth=2)
glue("glued_fig", fig, display=False)
This is an inline glue example of a figure: {glue:}glued_fig.
This is an example of pasting a glued output as a block:
See {ref}glue/gluing for more information.
Example:
```{code-cell} ipython3
import sympy as sym
x, y = sym.symbols('x y')
z = sym.Function('z')
z = sym.sqrt(x**2+y**2)
glue("example_eq", z, display=False)
```
To glue a math equation try
```{glue:math} example_eq
:label: glue-eq-example
```Result:
import sympy as sym
x, y = sym.symbols('x y')
z = sym.Function('z')
z = sym.sqrt(x**2+y**2)
glue("example_eq", z, display=False)
To glue a math equation try:
:label: glue-eq-example
See for more information.
:header-rows: 1
:widths: 10 20 20
* - Syntax
- Example
- Result
* - ```md
{doc}`path/to/document`
```
- ```md
See {doc}`../content/citations`
for more information.
```
- See {doc}`../content/citations`
for more information.
* - ```md
{doc}`text <path/to/document>`
```
- ```md
See {doc}`here <../content/citations>`
for more information.
```
- See {doc}`here <../content/citations>`
for more information.
<br/><br/><br/><br/>
```{note}
Footnotes are displayed at the very bottom of the page.
```
:header-rows: 1
:widths: 20 20 10
* - Syntax
- Example
- Result
* - ```md
[^ref]
[^ref]: Footnote text
```
- ```md
This is an example of a footnote.[^footnote1]
[^footnote1]: The definition for referencing
footnotes is generally placed at the bottom
of the document.
```
- This is a footnote reference.[^myref]
See Footnotes for more information.
Make sure you have a reference bibtex file. You can create one by running `touch references.bib`
or view a {download}`references.bib <../references.bib>` example.
:header-rows: 1
:widths: 20 20 20
* - Syntax
- Example
- Result
* - ```md
{cite}`mybibtexcitation`
```
- ```md
This example generates the following
citation {cite}`perez2011python`.
```
- This example generates the following
citation {cite}`perez2011python`.
To include a list of citations mentioned in the document, introduce the bibliography directive
```{bibliography}
:filter: docname in docnames
```See {doc}../content/citations for more information.