格式與元件參考

這頁是給內容編輯者的速查表,收錄目前整個文件實際用到的格式。每一段都先給「寫法」(灰底框),下面是實際「呈現結果」,照著寫即可。


標題層級

文件的標題分四層,由大到小:

# 頁面標題 H1
## 段落大標 H2
### 小標 H3
#### 更小標 H4

規則:

  • H1(#)只放在頁面最上方一次,當作整頁標題;內文裡不要再用。
  • H2(##)是段落大標,會自動加一條底線,也會進右側目錄。
  • H3 / H4 是小標,比內文稍微紮實一點,用來分子段落(例:步驟分組、子主題)。

呈現結果:

這是小標 H3

這是更小標 H4

每個 H2 / H3 都會自動產生錨點,可以用 #標題文字 連過去(見下方「連結」)。


內文與重點

內文是灰色細字;要標重點時用 **字** 包起來,會變成較亮的白字(只變色、不加粗,粗體留給標題)。

這是一段內文,把**要強調的字**用兩個星號包起來,就會變亮白。
也可以放`行內程式碼`,例如指令或設定名稱。

呈現結果:

這是一段內文,把要強調的字用兩個星號包起來,就會變亮白。 也可以放行內程式碼,例如指令或設定名稱。


步驟寫法

教學的每一步用「粗體編號標題 — 說明」開頭,需要的話下面接指令或截圖。這是本站操作教學最常用的格式。

**1. 開啟終端機** — 在 OC-1 的功能按鍵點終端機。

**2. 執行指令** — 送出下面這行。

```bash
openclaw models list --provider openai
```

呈現結果:

1. 開啟終端機 — 在 OC-1 的功能按鍵點終端機。

2. 執行指令 — 送出下面這行。

openclaw models list --provider openai

連結(兩種,外觀不同)

站內同頁滑行的錨點連結是正體跳到別頁或外部網站的連結是斜體,讀者一眼能分辨。

同頁滑行(錨點):[回到頁首](#格式與元件參考)
跳頁 / 外部:[設定 LLM](/zh-hant/quick-start/llm)

呈現結果:

想做「點一下滑到本頁某段」的目錄,就把連結寫成 [文字](#該段標題)


提示區塊(Callout)

只支援這 4 種,寫法::::類型 開頭、::: 結尾。

:::info
一般說明、補充資訊。
:::

:::success
成功 / 建議做法。
:::

:::warning
要小心、容易踩雷。
:::

:::danger
高風險、機密、不可逆操作。
:::

呈現結果:

一般說明、補充資訊。

成功 / 建議做法。

要小心、容易踩雷。

高風險、機密、不可逆操作。


清單

- 項目一
- 項目二
  - 子項目

1. 第一步
2. 第二步

呈現結果:

  • 項目一
  • 項目二
    • 子項目
  1. 第一步
  2. 第二步

程式碼區塊

```語言 開頭可自動語法上色,右上角會有 Copy 鈕可一鍵複製。

```bash
ssh -i ~/.ssh/key -p 18022 root@1.2.3.4
```

呈現結果:

ssh -i ~/.ssh/key -p 18022 root@1.2.3.4

引言 / 備註(Blockquote)

> 開頭。本站常用來放小提醒、或標「🎬 影片待補 / 📷 截圖待補」這類佔位。

> 這是一段備註,用來補充說明。

呈現結果:

這是一段備註,用來補充說明。


表格

| 欄位 | 說明 |
|------|------|
| A | 第一欄 |
| B | 第二欄 |

呈現結果(手機可橫向捲動):

欄位說明
A第一欄
B第二欄

分隔線

用三個以上的 -- - - 自成一行,畫一條分段橫線。

- - -

呈現結果:


圖片

在編輯後台直接拖拉上傳即可,會自動產生這種寫法:

![圖片說明](/images/uploads/你的圖.png)

圖片會以滿寬呈現、自動加圓角邊框。建議檔名用英文(如 openclaw-codex-01.png)。截圖含機密(token、email、IP)時,上傳前先馬賽克


影片(VideoEmbed 元件)

貼上 YouTube / Vimeo 的影片 ID:

<VideoEmbed id="aqz-KE-bpKQ" title="範例影片" />

呈現結果(16

可播放的播放器):


UI 名稱標籤(UI 元件)

標出介面上的按鈕 / 分頁名稱,會以亮白字標示:

點選 <UI>管理儀表板</UI> 進入後台。

呈現結果:

點選 管理儀表板 進入後台。