這篇完成:有一個可用的文件空間,標題與前台入口正確。
目錄與文章見 如何新增資料夾與文章。
路徑
側欄進文件後先到 空間列表(/admin/docs)。說明:建立與管理文件空間;點選標題進入目錄與頁面。
空狀態:「尚無文件空間」。右上角 新增空間。可搜尋空間名稱。未搜尋時可拖曳排序。
新增空間(逐步)
- 點 新增空間(
/admin/docs/spaces/new)。說明:填寫標題與 slug;儲存後可於文件樹新增根資料夾與頁面。 - 填下表後儲存。
| 欄位 | 說明 |
|---|---|
| 標題 | 後台與前台空間名稱 |
| 網址代稱(slug) | 非預設空間會出現在路徑,例如 /docs/product 的 product。用小寫英文、數字、連字號 |
| 摘要 | 選填;顯示於前台空間切換與預設總覽卡片 |
| 圖示 | 總覽與切換器上的小圖 |
- 回到列表,點標題進入該空間目錄。
大多數站台已經有預設空間,日常不必再新增。第二套手冊(例如產品 API)再新開空間。
編輯空間
列表進入該空間的設定(或空間編輯頁,標題「編輯空間設定」)。
- 預設空間的 slug 不能改。也不要自行建立 slug 為
default的新空間。 - 可改標題、摘要、圖示。
- 畫面上有 管理此空間的目錄與頁面 可回到目錄樹。
刪除空間
- 預設空間不能刪。
- 一般刪除:請先清空裡面的資料夾與文章,否則系統會拒絕。
- 空間內還有內容、且畫面出現 強制刪除:在 確認字串 輸入
DELETE,再按 強制刪除空間與全部節點。這會連目錄一起刪掉,無法復原。
改前台前綴(/docs)
空間列表若有 類型設定(通常僅擁有者):可改顯示名稱與前台網址前綴(類型代碼),例如改成 /help。
- 儲存後所有文件公開網址都會變。
- 系統會盡量自動改寫舊的文件轉址前綴;完成後請到 文件轉址 核對。
- 前綴用小寫英文開頭,僅英數與底線;不要與固定路由或已有網站頁面 slug 重複。
怎麼驗
- 空間列表看得到該空間。
- 點進去是空目錄或既有樹,可 新增根資料夾。
- 前台總覽:預設空間開
/docs;其他空間開/docs/{slug}(前綴以實際為準)。
常見卡住
| 狀況 | 怎麼辦 |
|---|---|
| 刪不掉空間 | 先清空節點,或用強制刪除(會全刪) |
| 改不了 slug | 那是預設空間,屬預期 |
| 改前綴後舊書籤失效 | 到文件轉址確認;重大調整前先與提昇科技確認 |
相關說明
- 文件中心概覽
- 如何新增資料夾與文章