將 Git 存放庫發佈至 Wiki

Azure DevOps 服務 |Azure DevOps Server |Azure DevOps Server 2022

您可以將已在 Git 存放庫中維護的內容發佈至 Azure DevOps Wiki。 您的存放庫可能包含軟體開發工具包（SDK）、產品檔、自述檔等檔案。 您也可以為單一小組項目發佈多個Wiki。

當您將 Markdown （.md） 檔案發佈至 Wiki 時，您會獲得數個優點：

• 將內容組織成受控頁面順序結構
• 瀏覽和篩選目錄
• 發佈新版本的內容
• 以您管理程式碼基底的相同方式管理內容
• 使用Wiki 搜尋 功能輕鬆地搜尋Wiki

如需詳細資訊，請參閱 已配置的 wiki 與發佈的程式碼作為 wiki。

本文說明如何使用 Azure DevOps 入口網站和 Azure DevOps CLI 來新增和編輯發佈至 Wiki 的內容。 您也可以離線工作，並以在 Git 存放庫內的程式碼上共同作業的方式更新 Wiki 內容。 如需詳細資訊，請參閱 離線更新Wiki頁面。

必要條件

開啟 Wiki

使用 支援的網頁瀏覽器 連線到您的 Azure DevOps 專案，然後選取 [Wiki]：

如果您需要切換小組專案，請選取 [Azure DevOps ] 以 流覽所有小組專案和小組。

將 Git 存放庫發佈至 Wiki

本節說明如何將 Git 存放庫發佈至 Wiki。 您可以在瀏覽器中直接使用 Azure DevOps UI，或使用 Azure DevOps CLI。

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {projectwiki, codewiki}]
                      [--version]

az devops wiki create --name "My Code Wiki" --type codewiki --repository MyCodeRepo --mapped-path /wikis --version main --output table

ID                                     Name            Type
------------------------------------   -------------   --------
0000aaaa-1b1b-2c2c-3d3d-444444eeeeee   My Code Wiki    codewiki

編輯、重新命名或刪除頁面

在 Azure DevOps 入口網站中，您可以編輯、重新命名或刪除 Wiki 頁面：

1. 在您的專案中，選取 [存放庫>檔案 ] 或 [ 程序代碼 > 檔案]。

2. 在檔案清單中，選取您要處理的頁面。

3. 選取檔案的 [更多選項 ]，然後選取動作：

   

下列各節說明如何更詳細地完成動作。

編輯 頁面

當您編輯檔案時，請使用連結來預覽您的變更，或標示相較於先前版本的變更。

• 若要捨棄您的變更，請選取 [ 取消]。 如需所支援 Markdown 功能的詳細資訊，請參閱 Markdown 使用方式的語法指引。

• 當您完成時，請新增有關更新的批注，然後選取 提交。

  

  系統會自動提供您建立提取要求的連結。 當您直接編輯Wiki分支時，可以忽略此訊息。

  

重新命名頁面

您想要在 Wiki TOC 中顯示的所有頁面都必須使用 Markdown （.md） 檔案類型。 您可以使用 [重新命名 ] 動作來重新命名檔案，包括變更擴展名。

下列範例會將 new-home-page.md 檔案重新命名為 New-Home-Page.md。 對應的頁面會顯示在Wiki TOC中，其標籤為「新增首頁」。

頁面標題會區分大小寫，而且在資料夾內必須是唯一的。 標題必須是 235 個字元或更少。 如需詳細資訊，請參閱 頁面標題命名限制。

刪除頁面

任何您不想出現在Wiki中的 Markdown 檔案，都可以從已發佈的資料夾中刪除。 如果您將檔案包含在 .order 檔案中，請從 .order 檔案中刪除對應的頁面條目。 如需詳細資訊，請參閱 變更頁面順序、新增或更新 .order 檔案。

新增頁面或多個頁面

有數種方式可將頁面新增至已發佈的Wiki：

• 將檔案新增至Wiki根資料夾或任何子資料夾
• 將檔案上傳至Wiki根資料夾或任何子資料夾
• 新增或更新任何 .order 檔案，以在Wiki TOC 中指定頁面順序

針對每個更新，您必須將變更提交至維基儲存庫。 然後，刷新您已發佈的存放庫上的維基，以檢閱變更。

從入口網站新增頁面

若要將頁面新增至已發佈的Wiki，請遵循下列步驟：

1. 在 Azure DevOps 入口網站中，移至已發布存放庫的 存放庫>檔案 或 程式代碼>檔案 。

2. 選取存放庫的 [更多選項 ]，然後選取 [ 新增>檔案]：

   

3. 在對話框中，輸入新檔案的名稱，其中包含 Markdown （.md） 檔類型。

   檔名應對應至您想要在Wiki TOC 中顯示的頁面標題。 以檔名中的連字元 （-） 取代頁面標題中的任何空格。 頁面標題會區分大小寫，而且在資料夾內必須是唯一的。 標題必須是 235 個字元或更少。 如需詳細資訊，請參閱 頁面標題命名限制。

   下列範例會新增名為 Page-4.md 的檔案，該檔案會顯示在wiki TOC中，其頁面標題為 “Page 4”。

   

   選取 ，創建。

4. 當頁面出現在檔案清單中時，請選取頁面，然後選取 [ 編輯]。 輸入頁面的內容。 如需詳細資訊，請參閱 Markdown 檔案、小工具、Wiki 和提取要求批註的語法指引。

5. 完成時，請選取 [ 認可]，將新頁面新增至已發佈的存放庫。

上傳檔案到資料夾

您也可以將檔案上傳至已發佈Wiki中的資料夾。 當您有想要新增的現有內容時，此選項很有用。

1. 在 Azure DevOps 入口網站中，移至已發布存放庫的 存放庫>檔案 或 程式代碼>檔案 。

2. 選取存放庫的 [更多選項 ]，然後選取 [上傳檔案]：[

   

3. 在 [ 認可 ] 對話框中，選取您要上傳的資料夾和檔案：

   顯示如何在 [提交] 對話框中選取您要上傳的資料夾和檔案的螢幕快照。

4. 完成時，請選取 [ 認可]，將檔案上傳至已發佈的存放庫。

新增具有子頁面的頁面

如果您希望 Wiki 中的頁面有子頁面，您需要具有相同名稱的 Markdown 檔案和資料夾。 檔案和資料夾必須位於相同的wiki資料夾中。

1. 遵循 從入口網站新增頁面中的步驟，建立新的 Markdown 檔案。

2. 若要建立對應的資料夾，請選取存放庫的 [更多選項 ]，然後選取 [ 新增>資料夾]。

3. 在 [ 新增資料夾] 對話框中，輸入資料夾名稱，必須與 Markdown 檔案名相同：

   

   選取 ，創建。

4. 在Wiki檔案清單中，選取新的資料夾。 將一或多個檔案新增為子頁面至資料夾。

新增或更新 .order 檔案

將檔案或資料夾新增至已發佈的存放庫之後，最後一個步驟是新增或更新任何新或更新資料夾的 .order 檔案。 更新頁面順序，以確保Wiki TOC 中顯示的新檔案和資料夾如預期般顯示。

如需詳細資訊，請參閱 變更頁面順序、新增或更新 .order 檔案。 .order 檔案中未列出的任何檔案會新增至頁面順序中字母列表的結尾。

使用 .order 檔案變更頁面順序

wiki 根目錄的 .order 檔案會指定根層級頁面的顯示順序。 檔案是對應資料夾中 Markdown 檔案的純文字清單，像是 Welcome、support、rel-2025 等等。 Wiki 中的每個資料夾也有一個 .order 檔案，可定義該資料夾的頁面順序。

請依照以下步驟來設定資料夾的排序序列檔案：

1. 在 [ 程序代碼 > 檔案] 頁面中，選取 [新增檔案]。 將檔案命名為 .order。

2. 編輯檔案內容，以定義資料夾中 Markdown 檔案的顯示順序。

   對於您要讓 wiki 用戶看見的資料夾中的每個頁面檔案，新增一個對應的條目。

   頁面標題會區分大小寫。 條目文字應與頁面標題和檔名中使用的大小寫一致，但不包括 Markdown (.md) 檔案類型。

下列範例顯示具有五個檔案之資料夾的 .order 檔案：

readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts

設定Wiki首頁

當您在 Azure DevOps 入口網站中選取 Wiki 時，Wiki 的首頁隨即開啟。

根據預設，當您建立Wiki時新增的第一頁會設定為Wiki首頁。 當您的Wiki有多個頁面時，依字母順序排列的第一個檔案會設定為首頁。

您可以在wiki根目錄的 .order 檔案中設定頁面順序，以指定要作為首頁的頁面。 請將首頁名稱放在根目錄 .order 檔案的第一行：

Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9

將資料夾升階至Wiki頁面

您可以將存放庫中的資料夾顯示為 Wiki 中的頁面。 此過程稱為將資料夾 升階 至頁面。

在此案例中，您需要下列設定：

• Wiki 中的 Markdown （.md） 檔案，其名稱與資料夾相同。

• Markdown 檔案和資料夾必須是 Wiki 檔案清單中相同位置的對等。

下列範例顯示名為 Test 的資料夾和 Markdown （.md） 檔案。 具有相同名稱的對等在相同位置的存在，會在Wiki序列中建立具有相同名稱的頁面：

選取Wiki版本

如果您的Wiki有數個已發佈的版本，預設會顯示最新版本。

您可以展開分支下拉式清單並選取要顯示的版本，以選取不同的 Wiki 版本：

解除發佈程式代碼Wiki

如果您不想再將 Git 存放庫發佈為 Wiki，您可以取消發布 Wiki。

1. 在 Wiki 清單中，選取您要取消發布的 Wiki，選取 [其他選項 ] （...） >取消發佈Wiki：

   

   選取 [取消發佈 ] 動作之後，隨即開啟對話框進行確認。

2. 在確認對話框中，選取 [取消發佈]：

   

相關內容

• 已布建與已發佈的Wiki
• 離線更新Wiki
• Wiki Markdown 指導