将 Git 存储库发布到 Wiki

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022

可以将 Git 存储库中已维护的内容发布到 Azure DevOps wiki。 存储库可能包含软件开发工具包（SDK）、产品文档、自述文件等。 还可以为单个团队项目发布多个 Wiki。

将 Markdown （.md） 文件发布到 Wiki 时，将获得以下几个好处：

• 将内容组织到托管页面序列结构中
• 浏览和筛选内容目录
• 发布新版本的内容
• 以管理代码库的方式管理内容
• 使用维基搜索功能轻松查找内容

有关更多信息，请参阅 预配的 wiki 与将代码作为 wiki 发布的比较。

本文介绍如何使用 Azure DevOps Web 门户和 Azure DevOps CLI 添加和编辑发布到 Wiki 的内容。 还可以脱机工作并更新 Wiki 内容，就像在 Git 存储库中协作处理代码一样。 有关详细信息，请参阅 脱机更新 Wiki 页面。

先决条件

打开 Wiki

使用 受支持的 Web 浏览器 连接到 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 Web 门户中，可以编辑、重命名或删除 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 存储库。 然后，刷新已发布存储库的 Wiki 以查看更改。

从 Web 门户添加页面

若要将页面添加到已发布的 Wiki，请执行以下步骤：

1. 在 Azure DevOps Web 门户网站中，转到 Repos>文件 或 代码>文件 以查看已发布的存储库。

2. 选择存储库的 “更多选项 ”，然后选择“ 新建>文件”

   

3. 在对话框中，输入包含 Markdown（.md） 文件类型的新文件的名称。

   文件名应与要在 Wiki TOC 中显示的页面标题匹配。 将页面标题中的任何空格替换为文件名中的连字符（-）。 页面标题区分大小写，并且在文件夹中必须是唯一的。 标题必须为 235 个字符或更少。 有关详细信息，请参阅 页面标题命名限制。

   以下示例添加一个名为 Page-4.md 的文件，该文件显示在 wiki TOC 中，其页面标题为“第 4 页”。

   

   选择 创建。

4. 当页面显示在文件列表中时，选择页面，然后选择 “编辑”。 输入页面的内容。 关于详细信息，请参阅 Markdown 文件、组件、wiki 和拉取请求注释的语法指南。

5. 完成后，通过选择 “提交”将新页面添加到已发布的存储库。

将文件上传到文件夹

还可以将文件上传到已发布 Wiki 中的文件夹。 如果具有要添加的现有内容，此选项非常有用。

1. 在 Azure DevOps Web 门户网站中，转到 Repos>文件 或 代码>文件 以查看已发布的存储库。

2. 选择存储库的 “更多选项 ”，然后选择“ 上传文件”：

   

3. 在 “提交 ”对话框中，选择要上传的文件夹和文件：

   

4. 完成后，通过选择 “提交”将文件上传到已发布的存储库。

添加包含子页的页面

如果希望 Wiki 中的页面具有子页，则需要具有相同名称的 Markdown 文件和文件夹。 文件和文件夹必须位于同一 Wiki 文件夹中。

1. 按照 Web 门户中的“添加页面”中的步骤创建新的 Markdown 文件。

2. 若要创建相应的文件夹，请选择存储库的 “更多”选项 ，然后选择“ 新建>文件夹”。

3. 在“ 新建文件夹 ”对话框中，输入文件夹名称，该名称必须与 Markdown 文件名相同：

   

   选择 创建。

4. 在 Wiki 文件列表中，选择新文件夹。 将一个或多个文件作为子页添加到文件夹。

添加或更新 .order 文件

将文件或文件夹添加到已发布的存储库后，添加或更新任何新文件夹或更新文件夹的 .order 文件。 更新页面序列，以确保新的文件和文件夹按预期显示在 Wiki TOC 中。

有关详细信息，请参阅 更改页面序列、添加或更新 .order 文件。 .order 文件中未列出的任何文件将添加到页面序列中字母列表的末尾。

使用 .order 文件更改页面序列

wiki 根 .order 文件指定根级页面的显示顺序。 该文件是页面名称的纯文本列表，对应于文件夹中的 Markdown 文件，例如 “欢迎”、“ 支持”、“ 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 Web 门户中选择 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

如果不再想要将 Git 存储库发布为 Wiki，可以取消发布 Wiki。

1. 在 Wiki 列表中，选择要取消发布的 Wiki。 选择 更多选项 （...） >取消发布 Wiki：

   

   选择 “取消发布 ”作后，将打开一个对话框进行确认。

2. 在确认对话框中，选择 “取消发布：

   

相关内容

• 预配与已发布的 Wiki
• 离线更新维基
• Wiki Markdown 指导