新增和編輯 Wiki 頁面
Azure DevOps Services |Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018
您可以在為小組專案布建 Wiki Git 存放庫 之後，將標題和內容新增至頁面。 有並存編輯和預覽體驗，您可以在其中編輯頁面並預覽內容。
瞭解如何執行下列工作：
- 開啟 Wiki
- 新增 Wiki 頁面
- 檢視頁面的修訂
- 編輯和刪除 Wiki 頁面
- 重新排序 Wiki 頁面
- 將頁面設為 Wiki 首頁
使用 Markdown 格式撰寫頁面時，您也可以使用格式窗格進行 RTF 格式設定，以及插入影像、附件和連結。
當您編輯頁面時，請輸入 Ctrl+S加以儲存。 若要使用自訂修訂訊息儲存，請選取 
[ 儲存] 旁的 。 如需更多快捷方式，請參閱 管理 Wiki 頁面的鍵盤快速鍵。
注意
若要將頁面新增或編輯至您從 Git 存放庫發佈的 Wiki，請參閱 將 Git 存放庫發佈至 Wiki。 本文說明如何新增和編輯您為小組專案布建的 Wiki 頁面。
必要條件
- 您必須擁有布建的 Wiki。 如果您的 Wiki 尚未建立，請 立即建立它。
- 您必須是小組專案的成員，才能新增或更新 Wiki 頁面。
- 您必須具備基本存取層級，才能編輯專案 Wiki。
開啟 Wiki
您可以使用 命令來檢視和開啟為專案 az devops wiki show 定義的 Wiki 頁面。 若要開始使用，請參閱 開始使用 Azure DevOps CLI。
az devops wiki show --wiki
[--open]
[--project]
[--subscription]
參數
- --wiki：必要專案。 Wiki 的名稱或識別碼。
- --open：選擇性。 在網頁瀏覽器中開啟 Wiki 頁面。
- --project -p：選擇性。 專案的名稱或識別碼。
- --subscription：選擇性。 訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶
az account set -s NAME_OR_ID 。
範例
開啟名為 '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]
參數
- --path：必要專案。 Wiki 頁面的路徑。
- --wiki：必要專案。 Wiki 的名稱或識別碼。
- --include-content：選擇性。 包含頁面的內容。
- --open：選擇性。 在網頁瀏覽器中開啟 Wiki 頁面。
- --project -p：選擇性。 專案的名稱或識別碼。
- --version -v：選擇性。 Wiki 頁面的版本 (ETag) 。
範例
在名為 'myprojectwiki' 的 Wiki 中取得具有路徑 'my wiki' 的 Wiki 頁面內容。
az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"
新增 Wiki 頁面
若要新增 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]
參數
- --path：必要專案。 Wiki 頁面的路徑。
- --wiki：必要專案。 Wiki 的名稱或識別碼。
- --comment：選擇性。 檔案新增作業的認可訊息中的批註。 預設值：使用 Azure DevOps CLI 新增頁面。
- --content：選擇性。 Wiki 頁面的內容。 如果指定了 --file-path，則會忽略。
- --encoding：選擇性。 檔案的編碼方式。 與 --file-path 參數搭配使用。
接受的值：ascii、utf-16be、utf-16le、utf-8
- --file-path：選擇性。 如果在檔案中指定內容，則為檔案輸入的路徑。
- --project -p：如果未設定為預設值，或透過 git 設定挑選，則為必要專案。專案的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。
注意
針對 Azure DevOps Server 2020，您可以使用下列命令來設定預設的伺服器實例、集合和專案。
az devops configure --defaults organization=https://ServerName/CollectionName project=ContosoWebApp
範例
使用內嵌內容在名為 'myprojectwiki' 的 Wiki 中建立路徑為 'my page' 的新頁面。
az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"
使用檔案內容在 Wiki 中以路徑 'my page' 更新頁面的內容。
az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8
內部部署Azure DevOps Server不支援 Azure DevOps CLI 命令。
Wiki 頁面標題命名限制
每個 Wiki 頁面都會對應至 Wiki Git 存放庫中的檔案。 您指派給 Wiki 頁面標題的名稱必須符合下列限制。
| 限制類型 |
限制 |
| 檔案名稱 |
完整頁面路徑不應超過 235 個字元。 |
| 唯一性 |
頁面標題區分大小寫，而且在 Wiki 階層中必須是唯一的。 |
| 特殊字元 |
- 不得包含任何 Unicode 控制字元或 Surrogate 字元
- 不得包含下列可列印字元： / \#
- 不得以句點 (.) 當做開頭或結尾
|
| 檔案大小 |
不可超過上限 18 MB |
| 附件檔案大小 |
不可超過上限 19 MB |
Wiki 頁面標題中的特殊字元
您可以指定包含一或多個這些特殊字元 : < > * ? | - 的頁面標題。 例如，您可以將 Markdown 檔案命名為 「FAQ？」 或 「Set-up guide」。 字元具有下列 URI 編碼字串：
| 字元 |
編碼字串 |
| : |
%3A |
| < |
%3C |
| > |
%3E |
| * |
%2A |
| ? |
%3F |
| | |
%7C |
| - |
%2D |
| " |
%22 |
| 限制類型 |
限制 |
| 檔案名稱 |
完整頁面路徑不應超過 235 個字元。 |
| 唯一性 |
頁面標題區分大小寫，而且在 Wiki 階層中必須是唯一的。 |
| 特殊字元 |
- 不得包含任何 Unicode 控制字元或 Surrogate 字元
- 不得包含下列可列印字元： / ： < \ * ？ \ | - #
- 不得以句點 (.) 當做開頭或結尾
- 離線新增的頁面標題不得包含空格。
|
| 檔案大小 |
不可超過上限 18 MB |
| 附件檔案大小 |
不可超過上限 19 MB |
編輯和刪除 Wiki 頁面
若要編輯現有的 Wiki 頁面，請開啟頁面並選取 [ 編輯]，或開啟操作功能表，然後選取 [ 編輯]。 您也可以使用鍵盤快速鍵 e 快速移至目前頁面的編輯。
針對程式碼 Wiki，您可以使用 Markdown 工具列來建立內容，在並存編輯器中編輯頁面。 此體驗與專案 Wiki 中的程式相同。 您也可以使用 Repos 中樞的 [編輯] 選項，編輯 Repos 中的Wiki 頁面。
注意
如果您的程式碼 Wiki 中有分支原則，請使用 Repos 中的編輯 來建立分支並繼續編輯。
若要刪除頁面，請從樹狀結構或頁面內的功能表開啟操作功能表，然後選取 [ 刪除]。 確認對話方塊中開啟的刪除。
注意
刪除頁面會刪除頁面以及所有中繼資料及其所有子頁面，如果階層中有任何) ，則 (。
編輯 Wiki 頁面
若要編輯 Wiki 頁面，請輸入 az devops wiki page update 命令。
az devops wiki page update --path
--version
--wiki
[--comment]
[--content]
[--file-path]
[--project]
[--subscription]
參數
- --path：必要。 Wiki 頁面的路徑。
- --version -v：必要專案。 要編輯之檔案的版本 (ETag) 。
- --wiki：必要專案。 Wiki 的識別碼名稱。
- --comment：選擇性。 刪除作業認可訊息中的批註。
- --file-path：選擇性。 如果在檔案中指定內容，則為檔案輸入的路徑。
- --project -p：選擇性。 專案的名稱或識別碼。
- --subscription：選擇性。 訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用
az account set -s NAME_OR_ID 帳戶。
注意
針對 Azure DevOps Server 2020，您可以使用下列命令來設定預設的伺服器實例、集合和專案。
az devops configure --defaults organization=https://ServerName/CollectionName project=ContosoWebApp
範例
使用名為 'myprojectwiki' 的 Wiki 中路徑 'my page' 更新頁面的內容，其中包含內嵌內容。
az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World" --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b
使用檔案內容在 Wiki 中以路徑 'my page' 更新頁面的內容。
az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b
刪除 Wiki 頁面
若要刪除 Wiki 頁面，請輸入 az devops wiki page delete 命令。
az devops wiki page delete --path
--wiki
[--comment]
[--project]
[--subscription]
[--yes]
參數
- --path：必要。 Wiki 頁面的路徑。
- --wiki：必要專案。 Wiki 的名稱或識別碼。
- --comment：選擇性。 刪除作業認可訊息中的批註。
- --project -p：選擇性。 專案的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID來設定預設專案。 如果未設定為預設值，或透過 git 組態挑選，則為必要專案。
- --subscription：選擇性。 訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用
az account set -s NAME_OR_ID 帳戶。
- --yes -y：選擇性。 請勿提示確認。
內部部署Azure DevOps Server不支援 Azure DevOps CLI 命令。
範例
在名為 'myprojectwiki' 的 Wiki 中，刪除路徑為 'my wiki' 的 Wiki 頁面。
az devops wiki page delete --path 'my wiki' --wiki 'myprojectwiki'
內部部署Azure DevOps Server不支援 Azure DevOps CLI 命令。
重新排序 Wiki 頁面
您可以在 Wiki 樹狀檢視內重新排序頁面，讓頁面以您想要的順序和階層顯示。 您可以在樹狀檢視中拖放頁面標題，以執行下列作業：
注意
在階層中移動頁面可能會中斷從其他頁面連結。 移動之後，您一律可以手動修正連結。 重新排序階層中的頁面不會影響頁面連結。
您也可以使用鍵盤快速鍵來重新排序頁面。 選取頁面，然後按 CTRL + 向上鍵 或 CTRL + 向下鍵 來變更頁面順序。
若要變更頁面的父子關聯性，請開啟其操作功能表，然後選取 [ 移動]。 [ 移動頁面] 對話方塊隨即開啟。 選取您可以移動目前頁面的父頁面。
如需鍵盤快速鍵的完整清單，請參閱 管理 Wiki 頁面的鍵盤快速鍵。
將頁面設為 Wiki 首頁
根據預設，當您建立 Wiki 時新增的第一頁會設定為 Wiki 首頁。 如果另一個頁面在樹狀結構頂端拖放頁面而變得更相關，您可以變更 Wiki 首頁。
下一步
![顯示醒目提示 [Wiki] 功能表選取專案的螢幕擷取畫面。](media/open-wiki-vert-brn.png?view=azure-devops)
[Azure DevOps] 來流覽所有小組專案和小組。
