跳至主要内容

📝 TailorMed 文檔編輯指南

給非技術人員的簡單指南 - 不需要懂程式，只要會打字就能編輯文檔！

🎯 快速開始​

文檔在哪裡？​

所有文檔都在 docs/ 資料夾中，用 Markdown 格式（.md 檔案）撰寫。

docs/
├── intro.md              ← 首頁文檔
├── Company/              ← 公司相關文檔
│   ├── intro.md
│   ├── overview.md
│   ├── services.md
│   └── ...
└── ...

✏️ 如何編輯文檔​

方法 1：直接編輯檔案（最簡單）​

  1. 找到 docs/ 資料夾
  2. 打開要編輯的 .md 檔案（可以用記事本、VS Code 等）
  3. 修改內容
  4. 儲存檔案
  5. 重新整理瀏覽器，就能看到更新！

方法 2：新增文檔​

  1. 在 docs/ 資料夾中建立新的 .md 檔案
  2. 複製下面的模板內容
  3. 填入您的內容
  4. 儲存檔案

📋 文檔模板​

複製以下內容到新檔案，然後填入您的內容：

---
sidebar_position: 1
---

# 文檔標題

這裡寫您的文檔內容...

## 章節標題

### 小節標題

- 列表項目 1
- 列表項目 2
- 列表項目 3

**粗體文字**

*斜體文字*

[連結文字](https://example.com)

📝 基本語法（Markdown）​

標題​

# 一級標題（最大）
## 二級標題
### 三級標題
#### 四級標題

文字格式​

**粗體文字**
*斜體文字*
~~刪除線~~

列表​

無序列表：

- 項目 1
- 項目 2
  - 子項目 2-1
  - 子項目 2-2

有序列表：

1. 第一項
2. 第二項
3. 第三項

連結​

[連結文字](https://example.com)

圖片​

![圖片說明](/img/圖片名稱.jpg)

💡 注意：圖片要放在 static/img/ 資料夾中

表格​

| 欄位1 | 欄位2 | 欄位3 |
|-------|-------|-------|
| 資料1 | 資料2 | 資料3 |
| 資料4 | 資料5 | 資料6 |

引用​

> 這是一段引用文字

程式碼區塊​

這是程式碼

增加段落間距​

Markdown 會將多個空行合併，所以要增加間距需要使用 HTML：

方法 1：使用 <br> 標籤

第一段文字

<br>

第二段文字

方法 2：使用間距類別（推薦）

第一段文字

<div class="spacing-md"></div>

第二段文字

可用的間距類別：

  • spacing-xs - 小間距
  • spacing-sm - 中小間距
  • spacing-md - 中等間距
  • spacing-lg - 大間距
  • spacing-xl - 超大間距

方法 3：自訂間距大小

第一段文字

<div style="margin-bottom: 2rem;"></div>

第二段文字

📁 文檔結構說明​

檔案開頭的設定（Front Matter）​

每個文檔檔案開頭都有這樣的設定：

---
sidebar_position: 1
---
  • sidebar_position: 數字越小，在側邊欄越靠上
    • 1 = 最上面
    • 2 = 第二個
    • 以此類推

資料夾結構​

  • 在 docs/ 下建立資料夾 = 在網站上建立分類
  • 資料夾名稱會成為側邊欄的分類名稱

範例：

docs/
├── Company/          ← 會顯示為「Company」分類
│   ├── intro.md
│   └── services.md
└── Products/         ← 會顯示為「Products」分類
    ├── intro.md
    └── features.md

🖼️ 如何添加圖片​

步驟：​

  1. 準備圖片

    • 建議格式：JPG、PNG、SVG
    • 建議大小：不超過 2MB

  2. 放置圖片

    • 將圖片放到 static/img/ 資料夾中
    • 例如：static/img/logo.png

  3. 在文檔中引用

    ![圖片說明](/img/logo.png)

範例：​

![TailorMed Logo](/img/logo.svg)

這是我們的 Logo 圖片

📂 常見操作​

新增一個新文檔​

  1. 在 docs/ 資料夾中建立新檔案，例如：新文檔.md
  2. 複製模板內容
  3. 填入您的內容
  4. 儲存檔案

新增一個分類​

  1. 在 docs/ 資料夾中建立新資料夾，例如：Products
  2. 在新資料夾中建立 intro.md 作為分類首頁
  3. 在 intro.md 中寫入內容

調整文檔順序​

修改檔案開頭的 sidebar_position 數字：

  • 數字越小 = 越靠上
  • 數字越大 = 越靠下

✅ 檢查清單​

編輯文檔後，請檢查：

  • 檔案已儲存
  • 標題格式正確（使用 # 符號）
  • 圖片路徑正確（放在 static/img/ 中）
  • 連結可以正常點擊
  • 在瀏覽器中預覽效果

🆘 常見問題​

Q: 修改後看不到更新？​

A: 重新整理瀏覽器（按 F5 或 Ctrl+R）

Q: 圖片顯示不出來？​

A: 檢查：

  1. 圖片是否放在 static/img/ 資料夾中
  2. 圖片路徑是否正確（例如：/img/logo.png）
  3. 圖片檔名是否正確（注意大小寫）

Q: 表格顯示不正常？​

A: 確保：

  1. 表格第一行是標題
  2. 第二行是分隔線（用 --- 或 |--|）
  3. 每行的欄位數量一致

Q: 如何讓文檔在側邊欄顯示？​

A: 文檔會自動顯示在側邊欄，只要：

  1. 檔案在 docs/ 資料夾中
  2. 檔案是 .md 格式
  3. 檔案開頭有正確的設定

📚 更多資源​

💡 小技巧​

  1. 使用範例：參考現有的文檔檔案，複製格式
  2. 分段撰寫：先寫大綱，再補充細節
  3. 定期備份：編輯前先複製一份備份
  4. 預覽效果：編輯後在瀏覽器中查看效果

需要幫助？ 隨時聯絡技術支援！