Markdown Cheat Sheet

When using a markdown element, it is recommended to use a blank line before and after the element. This ensures that the document is rendered correctly and also makes the markdown more readable. If you are not familiar with markdown, you can check the Markdown Guide.

Headers

# H1

## H2

### H3

#### H4

##### H5

###### H6

Heading IDs

This are useful for linking to a specific heading. It shows up in the URL starting with # symbol when you click on a heading link.

## Heading with ID {#custom-id}

Bold and Italic

_italic_
**bold**
**_bold italic_**

Strikethrough

~~Strikethrough~~

Lists

Unordered

- Item 1
- Item 2
  - Subitem 2.1
  - Subitem 2.2

Ordered

1. Item 1
2. Item 2
   1. Subitem 2.1
   2. Subitem 2.2

Tip
To create nested lists, indent the items by four spaces.

Links

[Link title](https://example.com)

Note
For linking to internal doc pages, see Linking other Docs section.

Images

![Alt text](https://example.com/image.jpg)

Blockquotes

> This is a blockquote

Tip
If you are using Planum Docs, you can use blockquotes to show alerts. Check the Alert Blockquotes section for more information.

Code

Inline

`code`

Example: Here is an inline code in a sentence.

Blocks

```python
print("Hello, World!")
```

Tip
If you are using Planum Docs, you can do alot more with codeblocks. Check the Codeblocks section for more information.

Tables

| Header 1 | Header 2 |
| -------- | -------- |
| Row 1    | Row 1    |
| Row 2    | Row 2    |

Horizontal Rule

---

Escaping

\*escaped\*

This let you escape * symbol that otherwise would indicate the text is italic: *escaped*

Footnotes

Here is a footnote reference[^1].

[^1]: Here is the footnote.

Example: Here is a footnote reference^[1].

Math

Planum Docs have built-in support for math equations. See the Using Math in Planum Docs page for more information.