Markdown Syntax Support

Basic Syntax#

Markdown is a lightweight and easy-to-use syntax for styling your writing.

Headers#

When the content of the article is extensive, you can use headers to segment:

1
# Header 1
2

3
## Header 2
4

5
## Large Header
6

7
### Small Header

Header previews would disrupt the structure of the article, so they are not displayed here.

Bold and Italics#

1
_Italic text_ and **Bold text**, together will be **_Bold Italic text_**

Preview:

Italic text and Bold text, together will be Bold Italic text

Links#

1
Text link [Link Name](http://link-url)

Preview:

Text link Link Name ↗

Inline Code#

1
This is an `inline code`

Preview:

This is an inline code

Code Blocks#

1
```js
2
// calculate fibonacci
3
function fibonacci(n) {
4
  if (n <= 1) return 1
5
  const result = fibonacci(n - 1) + fibonacci(n - 2) // [\!code --]
6
  return fibonacci(n - 1) + fibonacci(n - 2) // [\!code ++]
7
}
8
```

Preview:

1
// calculate fibonacci
2
function fibonacci(n) {
3
  if (n <= 1) return 1
4
  const result = fibonacci(n - 1) + fibonacci(n - 2) // [!code --]
5
  return fibonacci(n - 1) + fibonacci(n - 2) // [!code ++]
6
}

Currently using shiki as the code highlighting plugin. For supported languages, refer to Shiki: Languages ↗.

Inline Formula#

1
This is an inline formula $e^{i\pi} + 1 = 0$

Preview:

This is an inline formula $e^{i\pi} + 1 = 0$

Formula Blocks#

1
$$
2
\hat{f}(\xi) = \int_{-\infty}^{\infty} f(x) e^{-2\pi i x \xi} \, dx
3
$$

Preview:

Currently using KaTeX as the math formula plugin. For supported syntax, refer to KaTeX Supported Functions ↗.

Images#

1
![CWorld](https://cravatar.cn/avatar/1ffe42aa45a6b1444a786b1f32dfa8aa?s=200)

Preview:

Strikethrough#

1
~~Strikethrough~~

Preview:

Strikethrough

Lists#

Regular unordered list

1
- 1
2
- 2
3
- 3

Preview:

• 1
• 2
• 3

Regular ordered list

1
1. GPT-4
2
2. Claude Opus
3
3. LLaMa

Preview:

1. GPT-4
2. Claude Opus
3. LLaMa

You can continue to nest syntax within lists.

Blockquotes#

1
> Gunshot, thunder, sword rise. A scene of flowers and blood.

Preview:

Gunshot, thunder, sword rise. A scene of flowers and blood.

You can continue to nest syntax within blockquotes.

Line Breaks#

Markdown needs a blank line to separate paragraphs.

1
If you don't leave a blank line
2
it will be in one paragraph
3

4
First paragraph
5

6
Second paragraph

Preview:

If you don’t leave a blank line
it will be in one paragraph

First paragraph

Second paragraph

Separators#

If you have the habit of writing separators, you can start a new line and enter three dashes --- or asterisks ***. Leave a blank line before and after when there are paragraphs:

1
---

Preview:

Advanced Techniques#

Inline HTML Elements#

Currently, only some inline HTML elements are supported, including <kdb> <b> <i> <em> <sup> <sub> <br>, such as

Key Display#

1
Use <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Del</kbd> to reboot the computer

Preview:

Use Ctrl + Alt + Del to reboot the computer

Bold Italics#

1
<b> Markdown also applies here, such as _bold_ </b>

Preview:

Markdown also applies here, such as bold

Other HTML Writing#

Foldable Blocks超长的标题中文Foldable Blocks超长的标题中文#

1
<details><summary>Click to expand</summary>It is hidden</details>

Preview:

Tables#

1
| Header1  | Header2  |
2
| -------- | -------- |
3
| Content1 | Content2 |

Preview:

Footnotes#

1
Use [^footnote] to add a footnote at the point of reference.
2

3
Then, at the end of the document, add the content of the footnote (it will be rendered at the end of the article by default).
4

5
[^footnote]: Here is the content of the footnote

Preview:

Use ¹ to add a footnote at the point of reference.

Then, at the end of the document, add the content of the footnote (it will be rendered at the end of the article by default).

To-Do Lists#

1
- [ ] Incomplete task
2
- [x] Completed task

Preview:

• Incomplete task
• Completed task

Symbol Escaping#

If you need to use markdown symbols like _ # * in your description but don’t want them to be escaped, you can add a backslash before these symbols, such as \_ \# \* to avoid it.

1
\_Don't want the text here to be italic\_
2

3
\*\*Don't want the text here to be bold\*\*

Preview:

_Don’t want the text here to be italic_

**Don’t want the text here to be bold**

Embedding Astro Components#

See User Components and Advanced Components for details.