myst-detail

※ jupyter book의 ‘MyST syntax cheat sheet’ 참조하여 추가 정리

Note

/

Header

syntax

# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

result

Heading level 3

Quote

syntax

  > This is a quote

result

This is a quote

List

syntax

  1. First item
  2. Second item
      1. First sub-item

result

1. First item

2. Second item

   1. First sub-item

Link

syntax

  [Jupyter Book](https://jupyterbook.org)

result

Jupyter Book

Table

syntax

  ```{list-table} This table title
  :header-rows: 1
  :name: example-table

  * - Training
    - Validation
  * - 0
    - 5
  * - 13720
    - 2744
  ```

result

Table 2 This table title

Training	Validation
0	5
13720	2744

Admotion

syntax

  ```{admonition} This is a title
    An example of an admonition with a title.
  ```

result

Note

Note

This is an note admonition

Important

Important

This is an important admonition

Hint

Hint

This is an hint admonition

See Also

See also

This is an seealso admonition

Tip

Tip

This is an tip admonition

Attention

Attention

This is an attention admonition

Caution

Caution

This is an caution admonition

Warning

Warning

This is an warning admonition

Danger

Danger

This is an danger admonition

Error

Error

This is an error admonition

Figure

syntax

  ```{image} ../images/C-3PO_droid.png
  :height: 150px
  :name: image-example
  ```

result

to-do list

syntax

  ```
  - [ ] Mercury
  - [ ] Venus
  - [ ] Earth
  - [ ] Mars
  ```

result

• Mercury

• Venus

• Earth

• Mars

emoji (octicon)

syntax

  ```
  [sphinx style]
  - {octicon}`smiley;1em;sd-text-info`

  [github style]
  - |:smiley:|
  ```

result

smiley	thumbsup	workflow	tag	arrow-right

octicon 바로가기

button

syntax

  ```{button-link} https://example.com
  :color: primary
  :outline:
  button
  ```

result

button

tab

syntax

  ::::{tab-set}

  :::{tab-item} Label1
  Content 1
  :::

  :::{tab-item} Label2
  Content 2
  :::

  ::::

result

Label1

Content 1

Label2

Content 2

Math

syntax

  This is an example of a
  math block

  $$
  z=\sqrt{x^2+y^2}
  $$

result

This is an example of a math block

\[ z=\sqrt{x^2+y^2} \]

block code

syntax

  Wrap in-line code blocks in backticks: `boolean example = true;`.

result

  note = "Python syntax highlighting"
  print(node)

grid

syntax

  ::::{grid} 3
  :outline:

  :::{grid-item}
  A
  :::
  :::{grid-item}
  B
  :::
  :::{grid-item}
  C
  :::
  ::::

result

A

B

C

---