Markdown Syntax Support
Markdown is a lightweight "markup language."
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
Header previews would disrupt the structure of the article, so they are not displayed here.
Bold and Italics
_Italic text_
**Bold text**
**_Bold Italic text_**
Preview:
Italic text
Bold text
Bold Italic text
Links
Text link [Link Name](http://link-url)
Preview:
Text link Link Name
Inline Code
This is an `inline code`
Preview:
This is an inline code
Code Blocks
```js
// calculate fibonacci
function fibonacci(n) {
if (n <= 1) return 1
return fibonacci(n - 1) + fibonacci(n - 2)
}
```
Preview:
// calculate fibonacci
function fibonacci(n) {
if (n <= 1) return 1
return fibonacci(n - 1) + fibonacci(n - 2)
}
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$
Preview:
This is an inline formula
Formula Blocks
$$
\hat{f}(\xi) = \int_{-\infty}^{\infty} f(x) e^{-2\pi i x \xi} \, dx
$$
Preview:
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)
Preview:
Strikethrough
~~Strikethrough~~
Preview:
Strikethrough
Lists
Regular unordered list
- 1
- 2
- 3
Preview:
- 1
- 2
- 3
Regular ordered list
1. GPT-4
2. Claude Opus
3. LLaMa
Preview:
- GPT-4
- Claude Opus
- LLaMa
You can continue to nest syntax within lists.
Blockquotes
> 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.
If you don't leave a blank line
it will be in one paragraph
First paragraph
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:
---
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
Preview:
Use Ctrl + Alt + Del to reboot the computer
Bold Italics
<b> Markdown also applies here, such as _bold_ </b>
Preview:
Markdown also applies here, such as bold
Other HTML Writing
Foldable Blocks
<details><summary>Click to expand</summary>It is hidden</details>
Preview:
Click to expand
It is hiddenTables
| Header1 | Header2 |
| -------- | -------- |
| Content1 | Content2 |
Preview:
Header1 | Header2 |
---|---|
Content1 | Content2 |
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
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
Preview:
- Incomplete task
- Completed task
Special Blockquotes
> [!NOTE]
> Useful information that users should also know when browsing the content.
> [!TIP]
> Useful tips for doing things better or easier.
> [!IMPORTANT]
> Key information that users need to know.
> [!WARNING]
> Urgent information that requires users' immediate attention to avoid problems.
> [!CAUTION]
> Provides advice on the risks or negative consequences of certain actions.
Preview:
NOTE
Useful information that users should also know when browsing the content.
TIP
Useful tips for doing things better or easier.
IMPORTANT
Key information that users need to know.
WARNING
Urgent information that requires users’ immediate attention to avoid problems.
CAUTION
Provides advice on the risks or negative consequences of certain actions.
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\*\*
Preview:
_Don’t want the text here to be italic_
**Don’t want the text here to be bold**
Embedding Astro Components
The source code is located in the src/components
directory, generally not for writing, but for page customization.
You can add new components by following the writing style of existing components.
Footnotes
Here is the content of the footnote ↩