跳至主要内容

Docusaurus 常用 Markdown 語法

這份指南將 Docusaurus 常用的 Markdown 與 MDX 語法拆解為獨立區塊。你可以直接點擊代碼區塊右上角的複製按鈕，快速應用到你的文章中。

標題 (headings)​

標題會自動生成在右側的「On this page」目錄中。

## 二級標題
### 三級標題
#### 四級標題

文章目錄 (TOC)​

根據文章 Headings 生成文章目錄，有利於手機的使用者查看。

import TOCInline from '@theme/TOCInline';

<TOCInline toc={toc} />

文字格式 (style)​

粗體文字 (bold)​

**粗體文字**

斜體文字 (italic)​

*斜體文字*

刪除線 (delete)​

~~刪除線~~

圖片 (images)​

![圖片描述](/img/default.png)
[連結名稱](https://XXX.com)

清單與格式 (lists)​

無序清單 (unordered list, ul)​

- 項目 A
- 項目 B
  - 子項目
  - 子項目

有序清單 (order list, ol)​

1. 第一步
2. 第二步

表格 (tables)​

| 項目 | 內容 | 備註 |
| :--- | :---: | ---: |
| 靠左對齊 | 置中對齊 | 靠右對齊 |

引用 (blockquote)​

> Bug 就像貓，你不注意也會跳上你的鍵盤

程式碼 (code)​

行內程式碼 (inline code)​

`Inline Code`

程式碼區塊 (code)​

test.md
```markdown title="test.md" showLineNumbers
程式碼寫在這裡
```

特殊告示框 (admonitions)​

Docusaurus 專屬語法，用於標註重點資訊。

:::note[備註]
(灰色) 一般紀錄、補充說明。
:::
:::info[資訊]
(藍色) 適合放：地址、官網連結、交通地圖。
:::
:::tip[小技巧]
(綠色) 適合放：推薦美食、在地人才知道的拍攝位。
:::
:::warning[注意]
(黃色) 適合放：天雨路滑、蚊蟲叮咬、注意防曬。
:::
:::danger[危險]
(紅色) 適合放：嚴禁進入、懸崖危險、禁止戲水。
:::

摺疊區塊 (details)​

適合收納長篇幅的參考資料。

<details>
  <summary>點擊展開</summary>

  內容描述，可用任何 markdwon 寫在這裡。

</details>

分頁標籤 (tabs)​

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
  <TabItem value="drive" label="第一分頁" default>
    第一分頁的資訊
  </TabItem>
  <TabItem value="bus" label="第二分頁ab2">
    第二分頁的資訊
  </TabItem>
</Tabs>