A comprehensive guide to markdown syntax supported by theme. Each element works out-of-the-box for both dark and light mode.

Headings

Headings are created using # prefixes, with the number of hashes corresponding to the heading level (HTML <h1> through <h6>).

Also, when you hover over a heading, a sign would appear next to it, you can click on it to go to anchor link of that heading (this does not copy link, you still have to copy it from address bar)

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

… which is rendered as:

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Text Formatting

Inline Styles

markup:
 _merge: shallow

Line Spacing

New Paragraph

Leaving a blank line between two lines, creates a new paragraph, this adds more spacing between those lines.

Paragraph 1

Paragraph 2

… which is rendered as:

Paragraph 1

Paragraph 2

Line Break

A line break (by adding 2 extra spaces at end of line) does not create a new para but just adds a <br> element between them, this adds less spacing between those lines.

Paragraph 1  
Still Paragraph 1

… which is rendered as:

Paragraph 1
Still Paragraph 1

If you don’t like theme’s spacing between 2 components, try exploring spacing.

Links

Automatic Links

Clickable URL:

Non-clickable (using code):

Custom Text Links

External link:

Internal link:

Anchor link:

Footnotes

Footnote reference:

Above footnote link should be paired with actual footnote message

[^1]: Sample footnote message.

preferably added at the end of post (irrespective of where you add the message, it would always be rendered at end of post).

Lists

Ordered Lists

1. Ordered List Item 1
2. Ordered List Item 2
3. Ordered List Item 3
   1. Ordered Sub-List Item 1

… which is rendered as:

1. Ordered List Item 1
2. Ordered List Item 2
3. Ordered List Item 3
   1. Ordered Sub-List Item 1

Unordered Lists

- Unordered List Item 1
- Unordered List Item 2
- Unordered List Item 3
  - Unordered Sub-List Item 1

… which is rendered as:

• Unordered List Item 1
• Unordered List Item 2
• Unordered List Item 3
  • Unordered Sub-List Item 1

Task Lists

- [X] Checked Task
- [ ] Unchecked Task

… which is rendered as:

• Checked Task
• Unchecked Task

Definition Lists

Term
: Definition 1
: Definition 2

… which is rendered as:

Term

Definition 1

Definition 2

Blockquotes

A blockquote is created by starting a line with > :

> This is a blockquote.

… which is rendered as:

This is a blockquote.

Alert Blockquotes

Alert blockquotes help highlight important information using distinct styles.

Use the following syntax:

> [!NOTE]
> Useful information that users should know, even when skimming content.

Replace NOTE in above syntax with one of the following types to get different styles:

• NOTE [ ]
• TIP [ ]
• IMPORTANT [ ]
• WARNING [ ]
• CAUTION [ ]

Horizontal Rule

You can use asterisks (***), dashes (---), or underscores (___) to create a horizontal line:

Images

Example 1: A Plain Image

![alt text](path/to/image.jpg)

… which is rendered as:

Example 2: An Image with Caption

![alt text](path/to/image.jpg "Image Caption")

… which is rendered as:

For more advanced image rendering options, refer to Image Element.

Tables

Example 1: A simple Table

| Movie         | Year |
| ------------- | ---- |
| My Neighbor Totoro | 1988 |
| Spirited Away | 2001 |

Example 2: A Table with caption

| Movie         | Director       |
| ------------- | -------------- |
| My Neighbor Totoro | Hayao Miyazaki |
| Spirited Away | Hayao Miyazaki |
{caption="Studio Ghibli Films"}

… which is rendered as :

For more advanced image rendering options, refer to Table Element.

Code Blocks

Plain Multi-line Code Block

Surround code with triple backticks:

```
| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |
```

… which is rendered as :

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

Syntax-Highlighted Code Block

Add the language name after the opening backticks:

```json
{
    "syntax": "Header",
    "description": "Title"
}
```

… which is rendered as:

{
    "syntax": "Header",
    "description": "Title"
}