已配置的Wiki與發佈為程式碼的Wiki
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
您可以在小組專案 Wiki 或發布為程式代碼 Wiki 中維護 Wiki 內容。 透過以程式碼形式發佈的 Wiki,您可以維護數個版本化的 Wiki 以滿足內容需求,不過只有在已啟用 Azure Repos 時才可使用。
即使這兩個選項都會維護 Git 存放庫中的 Wiki 內容,但新增、更新和管理 Wiki 內容的方式仍會有所不同。
注意
發佈為程式代碼的 Wiki 功能目前可在 Azure DevOps Server 2018 及更高版本使用。 針對舊版,您只能 為您的小組專案布建Wiki。
Wiki 頁面功能表選項
透過布建的Wiki,您可以直接在Wiki中新增和編輯頁面。 被配置的Wiki內容的所有更新都會發生在Wiki中。
透過將內容發佈為程式碼 Wiki,您可以從Repos或Code新增、編輯和更新內容。
下圖顯示已配置的維基選項。 其中有幾個選項不支援用於發行為程式代碼的Wiki頁面。
例如, 發佈為程式代碼Wiki的 [在 Repos 中編輯] 選項會帶您前往 存放庫 頁面來編輯該特定頁面。 您為 Wiki 選取之分支中的頁面所做的更新會自動發佈至 Wiki。
支援的功能和操作差異
這兩種類型的Wiki都支援下列功能:
- Markdown 格式
- HTML 標記
- 插入和調整影像大小
- 數學表示法和字元
- 使用 # 來連結工作項目
- 附加檔案
- 篩選Wiki內容
- 列印Wiki頁面
- 離線更新內容
- 從Wiki新增或編輯頁面
下表摘要說明視Wiki類型而定,這些作業或功能可能會有所不同。
作業 | 已配置的Wiki | 發佈成程式碼維基 |
---|---|---|
支援多個維基,名稱wiki | ✔️ | |
新增或編輯來自 Repos>檔案或 程式代碼>檔案的頁面 | ✔️ | |
從 Wiki 還原到先前的修訂 | ✔️ | |
從 Repos 或 Code 還原為先前的修訂 | ✔️ | ✔️ |
維護版本設定的Wiki | ✔️ | |
選取Wiki版本 | ✔️ | |
取消發佈程式碼維基 | ✔️ |
新增頁面
針對這兩種類型的Wiki,選取 [新增頁面] 或 [新增子頁面]。 如需詳細資訊,請參閱 新增和編輯Wiki頁面。
瀏覽窗格中的頁面順序和頁面清單
配置的 Wiki 會在您在瀏覽窗格中新增或移動頁面時,自動管理頁面順序和頁面清單。
若要在瀏覽窗格中的發佈為程式碼的 Wiki 中建構頁面清單,請在根目錄中定義*.order*
檔案,並在每個包含子頁面的子資料夾或父頁面中定義此檔案。
這兩種類型的Wiki都遵循相同的檔案結構,只是發佈為程式代碼Wiki需要您手動維護頁面順序。
如需使用 .order
檔案的詳細資訊,請參閱 Wiki Git存放庫檔案和檔案結構。
頁面修訂並還原為舊版
您可以從Wiki檢視任何Wiki頁面的修訂。 選取 [修訂] 或 [ 檢視修訂] 功能表選項。
但是,還原程式會根據Wiki頁面類型而有所不同。
- 針對已布建的Wiki頁面,選取還原,如將提交還原至已布建的Wiki頁面中所述。
- 針對發佈為程式碼 Wiki 的頁面,請從本機分支進行工作,並提交合併請求以更新您正在工作的分支。
版本設定和下架維基
使用版本設定,您可以根據 Git 存放庫的版本分支,將不同的內容版本發佈至不同的 Wiki。 只有當您是透過將程式碼發佈到Wiki而創建該Wiki的人時,您才能使用版本控制和取消發佈功能。 如需詳細資訊,請參閱 取消發佈程式碼Wiki。
刪除專案 Wiki
注意
Wiki REST API 不支援刪除專案 Wiki。 因此,您必須改為刪除Wiki存放庫。
複製Wiki存放庫以備份其所有內容。 更多選項 包含複製 Wiki 的 URL,可用來複製 Wiki。
取得可備份Wiki的 Git存放庫標識碼。 您可以使用 REST API 來取得專案中的所有 Wiki。
例如,
GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1
傳回專案中的所有Wiki,因此您可以選擇要刪除的Wiki。使用 REST API 刪除備份 Git 存放庫。 使用您在上一個步驟中找到之專案 Wiki 的存放庫標識碼,並仔細檢查存放庫標識碼,因此您不會移除錯誤的存放庫標識碼。
例如,
DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1
離線更新維基
您可以離線工作,或在本機分支中更新已布建Wiki的內容,併發佈為程式代碼Wiki。 如需詳細資訊,請參閱如何離線克隆和更新Wiki頁面。