Wiki 檔案和檔案結構

Azure DevOps Services |Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018

了解專案 Wiki 和程式代碼 Wiki 的檔案和檔案結構。 下列指引可能會指定程式代碼Wiki,但它適用於這兩種類型的Wiki。

當您建立小組專案時,預設不會建立Wiki。 如需詳細資訊,請參閱 建立Wiki建立自述檔已布建的Wikis與以Wiki發行的程序代碼。

每個程式代碼Wiki都是由後端的 Git 存放庫所提供。 此存放庫會儲存 Markdown 頁面、影像、附件,以及頁面和子頁面的順序。 您可以透過 Azure DevOps 使用者介面建立 Wiki,然後您可以透過 Git 存放庫 URL 路徑編輯 Wiki。 如需發佈程式代碼 Wiki 的詳細資訊,請參閱 將 Git 存放庫發佈至 Wiki

Wiki 檔案和資料夾結構

小組專案 Wiki Git 存放庫會指派下列標籤。

  • 小組專案的Wiki存放庫: ProjectName.wiki
  • 主要分支: wikiMain

藉由在wikiMain分支上定義分支原則,以您管理任何其他 Git 存放庫的方式管理Wiki存放庫。 但是,您可以變更本機wikiMain分支,並將它們直接推送至遠端分支,而不需要定義任何原則。

Wiki 存放庫具有下列檔案和資料夾:

  • 在根層級輸入的每個 Markdown 頁面的檔案
  • 在根目錄和每個資料夾底下加上 .order 標籤的檔案
  • 每個具有子頁面之頁面的資料夾
  • .attachments 資料夾,儲存Wiki的所有附件

檔案命名慣例

每個檔案都需要在網頁標題中使用連字號,而不是空格。 例如, 如何參與 頁面標題會對應至 How-to-contribute.md 檔名。 頁面名稱會新增至 URL,確保您共用的連結維持不變,因為 Wiki 會隨時間變更。

每個 Wiki 頁面會對應至 Wiki Git 存放庫中的檔案。 您指派給網頁標題的名稱必須符合下列限制。

限制類型 限制
檔案名稱 完整頁面路徑應不超過 235 個字元。
唯一性 網頁標題會區分大小寫,且在 Wiki 階層中必須為唯一。
特殊字元 - 不得包含任何 Unicode 控制字元或 Surrogate 字元。
- 不得包含下列可列印字元: / \ #
- 不得以句號 .開頭或結尾。
檔案大小 不得超過 18 MB 的上限。
附件檔案大小 不得超過 19 MB 的上限。

Wiki 頁面標題中的特殊字元

您可以指定包含一或多個這些特殊字元 : < > * ? | -的頁面標題。 例如,您可以將 Markdown 檔案命名為「常見問題」或「設定指南」。 這些字元具有下列 URI 編碼字串:

字元 編碼字串
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" 22%
限制類型 限制
檔案名稱 完整頁面路徑應不超過 235 個字元。
唯一性 網頁標題會區分大小寫,且在 Wiki 階層中必須為唯一。
特殊字元 - 不得包含任何 Unicode 控制字元或 Surrogate 字元。
- 不得包含下列可列印字元: / \ : < > * ? | - #
- 不得以句號 .開頭或結尾。
- 離線新增的頁面標題不得包含空格符。
檔案大小 不得超過 18 MB 的上限。
附件檔案大小 不得超過 19 MB 的上限。

.order 檔案

.order 檔案會定義Wiki中的頁面順序。 下列視覺效果顯示Wiki TOC的範例,且其為對應的 .order 檔案。

Wiki TOC .order 檔案
Screenshot of wiki TOC example. Screenshot of Wiki example order file.

默認階層依字母順序排列,不過您可以在 .order 檔案中變更此階層。 如需如何重新排序Wiki頁面的詳細資訊,請參閱 新增和編輯Wiki頁面、重新排序Wiki頁面

刪除 .order 檔案以還原為字母排序

沒有 .order 檔案時,頁面會依字母順序排序。 若要還原為字母排序,請執行下列步驟:

  1. 複製Wiki複製 URL,並在瀏覽器開啟它。 這麼做會開啟 Git 存放庫 (檔案中樞),以備份 Wiki。
  2. 移至 .order 檔案並加以刪除。 檔案會在刪除之後自動建立,例如,在發行項的拖放動作中。