Skip to main content

Docusaurus

note

撰寫 Docs 會使用到的。

Command​

# 本地測試
npm run start 

# 建置
npm run build 

# 本地測試（檔案會使用 build/）
npm run serve 

# 部署
npm run deploy
tip

在部署至遠端儲存庫前，先透過 build、serve 指令在本地測試，沒問題的話則使用 deploy 將檔案推送至遠端。

Markdown Features​

提示區塊​

可以使用下方的區塊：

  • note
  • tip
  • info
  • caution
  • danger

使用方式為：

// :::類型 標題
// 內容
// :::
note

這是 note 區塊。

tip

這是 tip 區塊。

info

這是 info 區塊。

caution

這是 caution 區塊。

danger

這是 danger 區塊。

程式區塊​

可以透過在程式碼上方用註解的方式標記特定的行數。

  • 使用 // highlight-next-line，標記下一行。
  • 使用 // highlight-start 與 // highlight-end，標記註解間的行數。
// ```語言 title="標題"
// 程式碼
// ```

MDX 分頁​

note
mdx-code-block
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="A Tab" default>
  A Tab
</TabItem>
<TabItem value="B Tab">
  B Tab
</TabItem>
<TabItem value="C Tab">
  C Tab
</TabItem>
</Tabs>

More​