Ctrl+K

Markdown

1.5. Markdown#

last update: Feb 07, 2024

Here, you can learn the basic usage of Markdown. Markdown is a simple, lightweight markup language for creating formatted, structured text. This whole Jupyter Book source code are also written in Markdown (especiallly MyST). You can use Markdown to make websites, documents, notes, book, presentations, email messages. MyST is one of markedown derivatives which have features for scientific and technical documentation.

In the following, you see how to write Markdown and how it looks like.

# Heading 1
## Heading 2
### Heading 3

Heading 1

Heading 2

Heading 3

1.5.1. list#

- list item 1
- list item 2
- list item 3
    - list item 3-1
    - list item 3-2
        - list item 3-2-1
        * list item 3-2-2
        + list item 3-2-3

1. list item 1
2. list item 2
3. list item 3
    1. list item 3-1
    2. list item 3-2

  • list item 1

  • list item 2

  • list item 3

    • list item 3-1

    • list item 3-2

      • list item 3-2-1

      • list item 3-2-2

      • list item 3-2-3

  1. list item 1

  2. list item 2

  3. list item 3

    1. list item 3-1

    2. list item 3-2

1.5.2. Color#

You can use HTML in Markdown.

<font color="red">Red</font>

Red

1.5.3. Code#

```python
import streamlit as st
import numpy as np
import pandas as pd
```

import streamlit as st
import numpy as np
import pandas as pd

1.5.5. Checkbox#

- [ ] task 1
- [x] task 2

  • task 1

  • task 2

1.5.6. raw text, code, bold, italic, strikethrough#

```
asdf
```

`asdf`

*asdf*
_adsf_

**asdf**
__adsf__

***asdf***
___adsf___
*__adsf__*
~~asdf~~

asdf

asdf

asdf adsf

asdf adsf

asdf adsf adsf ~~asdf~~

1.5.7. Latex#

$\LaTeX$

$$
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq
\left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
$$

\(\LaTeX\)

\[ \left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right) \]

1.5.8. Quote#

> This is a quote.

This is a quote.

1.5.9. Table#

| Header 1 | Header 2 | Header 3 |
| :-------- | :--------: | --------: |
| align=left | align=center | align=right |
| cell 1   | cell 2   | cell 3   |
| cell 4   | cell 5   | cell 6   |
| caption |

Header 1

Header 2

Header 3

align=left

align=center

align=right

cell 1

cell 2

cell 3

cell 4

cell 5

cell 6

caption

1.5.10. In-page link#

[link to list](#list)

1.5.11. Reference#

Contents