新增和編輯Wiki頁面

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

為小組項目設定 Wiki Git存放庫 之後，您可以新增Wiki和頁面內容的標題。 Azure DevOps UI 提供並存體驗，您可以在其中編輯頁面，並在您工作時預覽變更。

在 [ 編輯 ] 窗格中，您可以使用 Markdown 格式語法來輸入頁面內容。 您也可以插入影像、附件和連結。 當您進行變更時，內容會在 [預覽 ] 窗格中更新。 具有特殊格式設定的內容，例如標題、清單、連結和圖片，將在預覽窗格中顯示為豐富文本。

當您編輯頁面時，請使用 Ctrl+S 鍵盤快捷方式快速儲存您的工作。 您也可以使用自定義修訂訊息來儲存您的工作，例如「已新增頁面連結」。這個選項可在 [ 儲存 ] 下拉選單上取得：

其他鍵盤快捷方式可供使用。 如需詳細資訊，請參閱 管理Wiki頁面的鍵盤快捷方式。

注意

本文說明如何在針對小組專案建立的Wiki中新增和編輯頁面。 如果您想要將頁面新增或編輯至從 Git 存放庫發佈的 Wiki，請參閱 將 Git 存放庫發佈至 Wiki。

Wiki 命令行工具

您可以使用 Azure DevOps CLI 命令來管理 Wiki 內容。 下表提供本文各節的連結，說明如何使用特定命令。

指令	描述
az devops wiki show	開啟Wiki並顯示Wiki首頁。
顯示 az devops wiki 頁面	在Wiki中顯示特定頁面。
az devops wiki page create（用於創建 DevOps 維基頁面的命令）	將新頁面新增至Wiki。
az devops 維基頁面更新	編輯Wiki中的現有頁面。
az devops wiki 頁面刪除	刪除Wiki中的頁面。

必要條件

類別	要求
專案存取	Wiki所在的項目成員。 您可以視需要向專案管理員要求存取權。
許可權	貢獻者群組 的成員。
存取層級	至少 基本 存取權。
任務	為您的項目準備 配置好的Wiki 。

開啟維基

您可以在瀏覽器中從 Azure DevOps 開啟及檢視小組專案的 Wiki 頁面，或使用 Azure DevOps CLI。

瀏覽器

使用 支援的網頁瀏覽器 連線到您的項目，然後選取 [Wiki]：

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

Azure DevOps CLI

您可以使用 命令來檢視和開啟專案的 az devops wiki show Wiki 頁面：

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

如需詳細資訊，請參閱 開始使用 Azure DevOps CLI。

基本參數

下列參數適用於 wiki show 命令：

參數	為必填項目	描述
--wiki	是的	Wiki 的名稱或識別碼。
--open	否	在網頁瀏覽器中開啟Wiki頁面。
--project -p	否	項目的名稱或識別碼。
--subscription	否	訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 命令設定預設訂閱。

如需詳細資訊，請參閱 Azure DevOps CLI 命令參考。

範例：檢視專案 Wiki

下列範例示範如何開啟名為 「MyProjectwiki」 的Wiki：

az devops wiki show --wiki MyProjectwiki --open

檢視Wiki頁面

您可以使用 Azure DevOps CLI az devops wiki show 命令來檢視特定頁面的內容：

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

其他參數

下表列出當您想要檢視特定頁面時，命令的更多參數wiki show：

參數	為必填項目	描述
--path	是的	Wiki 頁面的完整路徑。
--include-content	否	顯示完整頁面內容以及頁面元數據。
--version -v	否	與 ETag 實體標籤值對應的 Wiki 頁面版本。

如需詳細資訊，請參閱 Azure DevOps CLI 命令參考。

範例：檢視特定頁面

下列範例示範如何取得 「MyProjectwiki」 Wiki 中 “Get Started” 頁面的內容：

az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"

新增Wiki頁面

本節說明如何將頁面新增至Wiki。 您可以在瀏覽器中直接使用 Azure DevOps UI，或使用 Azure DevOps CLI。

瀏覽器

若要將新頁面新增至Wiki，您有兩個選項。 從選取清單中的頁面開始，例如首頁。

• 若要在與目前頁面相同的層級新增頁面，請選取 Azure DevOps UI 底部的 [ 新增頁面 ]。

• 若要將子頁面新增至目前頁面，請選取 [其他選項 ]（...） >新增子頁面。

您也可以使用鍵盤快捷方式來新增頁面。 選取目前的頁面，然後選取 n 或選取 c 來新增子頁面。 如需詳細資訊，請參閱 管理Wiki頁面的鍵盤快捷方式。

頁面標題和檔名

輸入頁面的唯一標題。 此值會區分大小寫。 標題會當做頁面的檔名使用。 在檔名中，頁面標題中的空格會取代為連字元 （-）。 例如，「如何參與」頁面標題會對應至檔名 How-to-contribute.md。 檔案的完整路徑應為 235 個字元或更少。

如需其他檔名限制，請參閱 Wiki Git存放庫檔案和檔案結構、檔案命名慣例。

Azure DevOps CLI

您可以使用 命令來新增 Wiki 頁面 az devops wiki page create ：

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

如需詳細資訊，請參閱 開始使用 Azure DevOps CLI。

參數：建立頁面

下列參數適用於 wiki page create 命令：

參數	為必填項目	描述	注意
--path	是的	Wiki 頁面的完整路徑。
--wiki	是的	Wiki 的名稱或識別碼。
--comment	否	在檔案Add操作的認可訊息中使用的註解。 未指定批注時，會套用預設值：「使用 Azure DevOps CLI 新增頁面」。
--content	否	以命令內嵌方式提供 Wiki 頁面的內容， 例如 --content "Hello World"。	如果您使用 參數指定頁面內容 --file-path ，則會 忽略此參數。
--file-path	否	包含頁面內容的檔案路徑。
--encoding	也許	頁面內容的編碼類型。 可能的值： ascii、 utf-16be、 utf-16le和 utf-8。	此參數支持 --file-path 參數。 --file-path 未指定 參數時，會忽略此參數。
--project -p	也許	項目的名稱或識別碼。 您可以使用 命令來設定預設專案 az devops configure -d project=NAME_OR_ID 。	當專案未按照預設配置或使用git config命令挑選時，參數必須是必要。

如需詳細資訊，請參閱 Azure DevOps CLI 命令參考。

範例：在瀏覽器中新增Wiki頁面

下列命令會在名為 「MyProjectwiki」 的 Wiki 中建立路徑 「Get Started」 的新頁面。命令會內嵌指定 Wiki 頁面內容：

az devops wiki page update --path 'Get Started' --wiki MyProjectwiki --content "**Contributor Support**<br>TODO: Add introduction"

範例：在瀏覽器中更新Wiki頁面

下列命令會使用另一個檔案的內容來更新現有的Wiki頁面。 wiki 頁面位置是使用 --path 'Get Started' 參數來設定。 頁面內容是透過--file-path ./get-started-content.txt參數取得。 也會指定檔案的編碼方式。

az devops wiki page update --path 'Get Started' --wiki MyProjectwiki --file-path get-started-content.txt --encoding utf-8

頁面標題和檔名限制

每個Wiki頁面都會對應至Wiki Git存放庫中的檔案。 下列限制適用於頁面檔名和檔案大小：

• 檔名：選擇頁面檔案的名稱時，請記住，檔案的完整路徑應為 235 個字元或更少。 頁面的完整路徑包含存放庫 URL、頁面檔案的資料夾路徑，以及頁面檔名。 例如： https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md 。

• 唯一性：頁面檔名在其Wiki存放庫階層中的資料夾位置內必須是唯一的。 名稱區分大小寫。

• 特殊字元：頁面檔名有下列特殊字元的限制：

  • 無 Unicode 控制字元或代理字元
  • 無可列印字元：正斜線 /、反斜線 \、哈希 #
  • 名稱開頭或結尾沒有句點 . 符號

• 檔案大小：頁面檔案大小上限為 18 MB。

• 附件檔案大小：頁面檔案的任何附件大小上限為 19 MB。

允許的特殊字元

頁面檔名中允許使用數個特殊字元，例如冒號 : 和連字元 -。 例如，您可以將 Markdown 檔案命名為 FAQ：0525 或 Setup-Guide。

這很重要

若要避免頁面語法和瀏覽器瀏覽中的錯誤，請勿在頁面檔名中使用空格符 （ ）。 如果您根據頁面標題命名頁面檔案，請將頁面標題中的任何空格取代為檔名中的連字元 （-）。

下表列出Wiki頁面檔名中允許的特殊字元，以及對應的URI編碼字串：

字元	象徵	URI 字串
結腸	:	%3A
左角括弧	<	%3C
右角括弧	>	%3E
星號 （通配符）	*	%2A
問號	?	%3F
管道	|	%7C
連字符 （破折號）	-	%2D
雙引號	"	22%

例如，檔案名 FAQ：0525 會編碼為 FAQ%3A0525。

設定Wiki首頁

根據預設，當您建立Wiki時新增的第一頁會設定為Wiki首頁。 如果另一個頁面更相關，您可以變更Wiki首頁。 如需詳細資訊，請參閱 重新排列或移動Wiki頁面。

編輯和刪除Wiki頁面

本節說明如何編輯或刪除Wiki中的頁面。 您可以在瀏覽器中直接使用 Azure DevOps UI，或使用 Azure DevOps CLI。

瀏覽器

有數種方式可以在瀏覽器中編輯現有的 Wiki 頁面：

• 開啟Wiki頁面，然後選取 [ 編輯]。
• 開啟Wiki頁面，並使用鍵盤快捷方式 e.
• 選取頁面清單中的 Wiki 頁面，然後選取 [其他選項 ]（...） >編輯。

如需特定編輯函式的詳細資訊，請參閱 使用 Markdown 指引。

在 Repos 中編輯程式開發文件 Wiki

當您將程式代碼發佈為Wiki時，您可以在 Repos 中樞編輯 Wiki 頁面。 Markdown 工具列格式選項提供相同的並存編輯器體驗。 選擇編輯>在 Repos 中編輯以建立分支並繼續編輯：

[ 在 Repos 中編輯 ] 選項僅適用於已啟用分支原則的程式代碼 Wiki。 如果您沒有看到此選項，可能是因為您的Wiki不是程式碼Wiki，或未啟用分支原則。 如需詳細資訊，請參閱 分支原則和設定。

在瀏覽器中刪除Wiki頁面

若要刪除 Wiki 頁面，請在頁面清單中選取 Wiki 頁面，然後選取 [其他選項 ]（...） >刪除。 您也可以從頁面的右鍵選單中選取 [ 刪除 ]。

選取 [ 刪除] 之後，請確認對話框中的刪除。

注意

當您刪除Wiki頁面時，也會刪除頁面的所有元數據，以及附加至頁面的任何子頁面。

Azure DevOps CLI

您可以使用 命令編輯 Wiki 頁面 az devops wiki page update ：

az devops wiki page update --path
                           --version
                           --wiki
                           [--comment]
                           [--content]
                           [--file-path]
                           [--project]
                           [--subscription]

如需詳細資訊，請參閱 開始使用 Azure DevOps CLI。

參數：更新頁面

下列參數適用於 wiki page update 命令：

參數	為必填項目	描述	注意
--path	是的	Wiki 頁面的完整路徑。
--wiki	是的	Wiki 的名稱或識別碼。
--version -v	否	與 ETag 實體標籤值對應的 Wiki 頁面版本。
--comment	否	要用於檔案 刪除 操作的提交訊息中的批注。 未指定批注時，會套用預設值：「使用 Azure DevOps CLI 更新頁面」。
--file-path	否	包含頁面內容的檔案路徑。
--project -p	也許	項目的名稱或識別碼。 您可以使用 命令來設定預設專案 az devops configure -d project=NAME_OR_ID 。	當專案未按照預設配置或使用git config命令挑選時，參數必須是必要。
--subscription	否	訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 命令設定預設訂閱。

如需詳細資訊，請參閱 Azure DevOps CLI 命令參考。

範例：使用內嵌內容更新Wiki頁面

下列命令會更新名為 「MyProjectwiki」 的 Wiki 中 「Get Started」 頁面的內容。命令會內嵌指定 Wiki 頁面內容：

az devops wiki page update --path 'Get Started' --wiki MyProjectwiki --content "**Contributor Support**<br>TODO: Add introduction" --version 1234abcd5678efgh2345ijkl6789mnop3456qrst

範例：使用檔案內容更新Wiki頁面

下列命令會使用另一個檔案的內容來更新現有的Wiki頁面。 wiki 頁面位置是使用 --path 'Get Started' 參數來設定。 頁面內容是透過--file-path ./get-started-content.txt參數取得。 也會指定檔案的編碼方式。

az devops wiki page update --path 'Get Started' --wiki MyProjectwiki --file-path ./get-started-content.txt --encoding utf-8 --version 1234abcd5678efgh2345ijkl6789mnop3456qrst

刪除Wiki頁面

您可以使用 命令編輯 Wiki 頁面 az devops wiki page delete ：

az devops wiki page delete --path
                           --wiki
                           [--comment]
                           [--project]
                           [--subscription]
                           [--yes]

如需詳細資訊，請參閱 開始使用 Azure DevOps CLI。

參數：刪除頁面

下列參數適用於 wiki page delete 命令：

參數	為必填項目	描述	注意
--path	是的	Wiki 頁面的完整路徑。
--wiki	是的	Wiki 的名稱或識別碼。
--comment	否	要用於檔案 刪除 操作的提交訊息中的批注。 未指定批注時，會套用預設值：「使用 Azure DevOps CLI 刪除的頁面」。
--project -p	也許	項目的名稱或識別碼。 您可以使用 命令來設定預設專案 az devops configure -d project=NAME_OR_ID 。	當專案未按照預設配置或使用git config命令挑選時，參數必須是必要。
--subscription	否	訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 命令設定預設訂閱。
--yes -y	否	表示您不希望作業提示您進行確認。

如需詳細資訊，請參閱 Azure DevOps CLI 命令參考。

範例：刪除Wiki頁面

下列命令會刪除名為 「MyProjectwiki」 的 Wiki 中的 [開始使用] 頁面：

az devops wiki page delete --path 'Get Started' --wiki 'MyProjectwiki'

重新排序或移動Wiki頁面

在瀏覽器中，您可以在Wiki樹檢視中重新排序頁面，讓頁面以慣用的順序顯示。 預設序列依檔名依字母順序排列。 您可以依文章、類別或目標讀者來重新排序頁面的順序。

您可以在樹檢視中的頁面標題上使用拖放動作來完成下列工作：

• 移動：變更頁面的頁面/子頁面關聯性。 如果您在Wiki序列內移動頁面，則來自其他Wiki頁面的頁面連結可能會中斷。 移動頁面之後，您可以手動 修正這些連結 。

• 重新排序：變更Wiki序列中頁面的順序。 重新排序 Wiki 序列中的頁面不會影響頁面連結。

修正頁面移動后的中斷連結

若要在Wiki序列中移動頁面之後修正中斷的連結，請遵循下列步驟：

1. 測試Wiki中的其他頁面，並尋找已移動頁面的連結。

   檢查頁面上的錯誤訊息或遺漏內容。

2. 開啟具有中斷連結的頁面，選取 [ 編輯]，然後移至頁面內容中的中斷連結。

   若要在內容中尋找中斷的連結，您可以搜尋行動頁面的名稱、移動頁面的源檔路徑，或中斷連結的連結文字。

3. 更新中斷的連結。 典型的修正方式是變更連結中的 URL 或路徑，以將行動頁面的新位置設為目標。

4. 將您的變更儲存到頁面，讓連結更新。

5. 在瀏覽器中開啟更新的頁面，並測試連結。 確認它已成功開啟移動的頁面。

變更最上層頁面的順序

您可以使用鍵盤快捷方式，在Wiki序列中重新排序最上層頁面。 此動作不適用於子頁面。

在Wiki頁面清單中選取頁面，並使用 CTRL + 向上鍵 或 CTRL + 向下鍵 快捷方式來行動序列中的頁面。 變更會立即套用。

變更頁面/子頁面順序

您也可以變更 Wiki 序列中任何頁面的頁面/子頁面順序。

1. 選取您要在Wiki頁面清單中移動的頁面。

2. 選取 [其他選項]（...） >移動，這會開啟 [移動頁面] 對話框。

3. 在 [ 移動頁面 ] 對話框中，選取要作為新 父 頁面的頁面。

   

4. 選取新的父頁面之後，系統會根據頁面移動來掃描任何潛在的中斷連結。 它會報告需要調整的連結：

   

5. 選取 [更新頁面和工作專案中受影響的連結] 選項，然後選取 [ 移動 ] 以完成頁面移動。

如需完整的鍵盤快捷方式清單，請參閱 管理Wiki頁面的鍵盤快捷方式。

相關內容

• 檢視維基頁面的歷程記錄與還原
• 比較布建與已發佈的Wiki
• 使用wiki Markdown指引