Back

Markdown Syntax SupportMarkdown 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:

# Header 1

## Header 2

## Large Header

### Small Header
markdown

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

Bold and Italics#

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

Preview:

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

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

Preview:

Text link Link Name

Inline Code#

This is an `inline code`
markdown

Preview:

This is an inline code

Code Blocks#

```js
// calculate fibonacci
function fibonacci(n) {
  if (n <= 1) return 1
  const result = fibonacci(n - 1) + fibonacci(n - 2) // [\!code --]
  return fibonacci(n - 1) + fibonacci(n - 2) // [\!code ++]
}
```
markdown

Preview:

// calculate fibonacci
function fibonacci(n) {
  if (n <= 1) return 1
  const result = fibonacci(n - 1) + fibonacci(n - 2) 
  return fibonacci(n - 1) + fibonacci(n - 2) 
}
js

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

Inline Formula#

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

Preview:

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

Formula Blocks#

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

Preview:

f^(ξ)=f(x)e2πixξdx\hat{f}(\xi) = \int_{-\infty}^{\infty} f(x) e^{-2\pi i x \xi} \, dx

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

Images#

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

Preview:

CWorld

Strikethrough#

~~Strikethrough~~
markdown

Preview:

Strikethrough

Lists#

Regular unordered list

- 1
- 2
- 3
markdown

Preview:

  • 1
  • 2
  • 3

Regular ordered list

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

Preview:

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

You can continue to nest syntax within lists.

Blockquotes#

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

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.

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

First paragraph

Second paragraph
markdown

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:

---
markdown

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#

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

Preview:

Use Ctrl + Alt + Del to reboot the computer

Bold Italics#

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

Preview:

Markdown also applies here, such as bold

Other HTML Writing#

Foldable Blocks#

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

Preview:

Click to expandIt is hidden

Tables#

| Header1  | Header2  |
| -------- | -------- |
| Content1 | Content2 |
markdown

Preview:

Header1Header2
Content1Content2

Footnotes#

Use [^footnote] 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).

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

Preview:

Use 1 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#

- [ ] Incomplete task
- [x] Completed task
markdown

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.

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

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

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.

Footnotes#

  1. Here is the content of the footnote

Markdown Syntax Support
https://astro-theme-pure.vercel.app/blog/markdown
Author Pure Lab
Published at July 26, 2024
Copyright CC BY-NC-SA 4.0
Comment seems to stuck. Try to refresh?✨