将 Git 存储库发布到 Wiki
Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018
在本快速入门中，了解如何执行以下任务：
- 打开 Wiki
- 将 Git 存储库发布到 Wiki
- 编辑已发布 Wiki 的页面
- 将页面添加到已发布的 Wiki
- 更改已发布 Wiki 的页面序列
- 使页面成为 Wiki 主页
已在 Git 存储库中维护的内容可以发布到 Wiki。 例如，这可以是写入以支持软件开发工具包 (SDK) 、产品文档或自述文件的内容。 可以在单个团队项目中发布多个 Wiki。
通过将 Markdown 文件发布到 Wiki，可以获得以下优势：
- 将内容组织到分层页面结构中。
- 读者可以浏览和筛选的目录。
- 发布新版本的内容。
- 以管理代码库的方式管理内容。
- 读者可以使用 Wiki 搜索功能轻松搜索 Wiki。
有关管理不同 Wiki 类型的信息，请参阅 预配的 Wiki 之间的差异，并将代码发布为 Wiki。
提示
可以使用本文中所述的步骤添加和编辑已发布到 Wiki 的内容。 或者，还可以通过 Git 存储库脱机工作并更新 Wiki 内容，就像通过 Git 存储库协作处理代码一样。 有关详细信息，请参阅 脱机更新 Wiki 页面。
先决条件
- 你必须有一个团队项目。 如果还没有团队项目， 请创建一个项目。
- 必须为项目启用Azure Repos服务。
- 必须在团队项目中定义 Git 存储库。 理想情况下，此存储库包含至少一个 Markdown 文件，你想要发布到 Wiki。 如果需要添加 Git 存储库，请参阅 在项目中创建新的 Git 存储库。
- 您必须具有将代码发布为 Wiki 的权限。 默认情况下，将为 参与者组的成员设置此权限。
- 有权参与 Git 存储库的任何人都可以添加或编辑 Wiki 页面。
打开 Wiki
首先使用 受支持的 Web 浏览器 连接到项目，然后选择 Wiki。
Azure DevOps 以 将 Git 存储库发布到 Wiki
在现有 Git 存储库中维护 Markdown 文件并将其发布到 Wiki 时，请选择此选项。
选择“ 发布代码为 Wiki”。
备注
如果项目未定义 Git 存储库，则不会显示“ 发布代码”作为 Wiki 选项。 创建新的 Git 存储库，然后返回并刷新此页面。
如果已预配团队项目 Wiki，请在 Wiki 的上下文菜单中选择 “发布代码 Wiki”。
选择包含 Markdown 文件和命名 Wiki 存储库的存储库、分支和文件夹。 Git 存储库必须位于团队项目中。
如果要将存储库中的所有 Markdown 文件发布到 Wiki，请指定存储库的根目录。
选择 “发布”。 Wiki 存储库填充了所选存储库中包含的 Markdown 文件和文件夹。
例如，下图显示了在步骤 2 中选择的 azure-docs-sdk-node 存储库中包含的文件的已发布存储库。
TOC (wiki 目录) 包含以下文件：
存储库/分支/文件夹中定义的每个 Markdown 文件 (文件类型=.md) 按字母顺序列出，TOC 标题派生自 Markdown 文件名
已发布文件夹中定义的每个子文件夹的父页，即使它不包含任何 Markdown 文件也是如此。
下面是 azure-docs-sdk-node 存储库内容的图像。
Git 存储库分支的负责人现在映射到 Wiki。 分支和所选文件夹内所做的任何更改 () 将自动反映在 Wiki 中。 没有涉及其他工作流。
备注
最多可以发布 10 个 Wiki。
对于使用已添加的 Markdown 文件预配的 Wiki，现在可以按照在 Git 存储库中维护代码的方式添加或编辑页面。
编辑、重命名或删除页面
若要编辑、重命名或删除页面，请打开 Repos > 文件 或 代码 > 文件。
选择所需的页面，选择
“操作”，然后选择所需的操作。
备注
可以通过在选择发布到 Wiki 的分支上定义分支策略，以管理任何其他 Git 存储库的方式管理 Wiki 存储库。 但是，如果没有定义任何策略，你可以进行更改，并从 Web 门户或客户端直接推送到分支。
编辑页面
可以使用编辑模式下提供的链接预览更改或突出显示以前版本所做的更改。 若要放弃更改，请选择“ 取消”。 有关支持的 Markdown 功能的详细信息，请参阅 Markdown 用法的语法指南。
完成更新后，选择 “提交”，然后填写 “提交 ”对话框窗体。
系统会自动提供用于创建拉取请求的链接。 直接编辑 Wiki 分支时，可以忽略此消息。
提示
更改文件的名称或大小写时，需要更新 .order 文件以反映更改。 若要了解详细信息，请跳转到 “更改页面序列”，添加或更新 .order 文件。
重命名页面
要显示在 TOC 中的所有页面都必须具有 .md 作为其文件类型。 选择 “重命名 ”以相应地重命名文件。
例如，此处将 new-home-page.md 重命名为 New-Home-Page.md。 此页面显示在 TOC 中，标签为“新建主页”。
页面标题区分大小写，必须在文件夹中是唯一的，并且必须少于 235 个字符。 有关其他游戏限制，请参阅 页面标题命名限制。
删除页面
任何不想显示在 Wiki 中的 Markdown 文件，都可以从已发布的文件夹中删除。 如果已将该文件包含在 .order 文件中，请从 .order 文件中删除其条目。 若要了解详细信息，请跳转到 更改页面序列、添加或更新 .order 文件。
添加页面或页面
可以将页面添加到已发布的 Wiki，如下所示：
- 从 Web 门户将文件添加到根文件夹或子文件夹
- 将文件上传到根文件夹或子文件夹
- 添加或更新 .order 文件以在 Wiki TOC 中指定页面序列。
每次更新都需要将更改提交到存储库。 然后，你可以为已发布的存储库刷新 Wiki 以查看更改。
从 Web 门户添加页面
从已发布存储库的存储库>文件或代码>文件中，选择“操作”
，然后选择“文件”。
输入页面的名称，确保指定 .md 文件类型。 文件名应对应于要显示在 TOC 中的页面标题，短划线代替空格。 指定 235 个字符或更少的唯一标题。 页面标题区分大小写。 有关其他游戏限制，请参阅 页面标题命名限制。
例如，若要添加作为 第 4 页显示在 TOC 中的页面，请添加名为 Page-4.md 的文件。
输入页面的内容。 有关支持的 Markdown 功能的详细信息，请参阅 Markdown 文件、小组件、Wiki 和拉取请求注释的语法指南。
完成后，选择 “提交”，然后填写 “提交 ”对话框窗体。
将文件上传到文件夹
如果已定义现有内容，则可以将其上传到文件夹中。 选择
“操作”，然后选择“ 上传文件” () 。
填写 “提交 ”对话框窗体，选择要上传的文件夹和文件。
添加父页和子页
若要添加父页，首先会在根文件夹级别添加 Markdown 文件，然后添加具有相同标签的文件夹。
若要添加文件夹，请选择 “文件夹”，然后填写“ 新建文件夹 ”对话框窗体。 指定至少一个文件以对应于文件夹中的子页。
将所需的所有文件作为子页添加到文件夹。
添加或更新 .order 文件
将文件或文件夹添加到 Wiki 存储库时，最后一步是添加或更新已更新文件夹的 .order 文件。 此操作反映了要在 TOC 中显示的页面序列。 有关详细信息，请参阅 更改页面序列、添加或更新 .order 文件。 .order 文件中未列出的任何文件将添加到字母顺序列表的末尾，因为其顺序设置为 int。MaxValue。
更改页面序列、添加或更新 .order 文件
每个 .order 文件定义文件夹中包含的页面序列。 根 .order 文件指定在根级别定义的页序列。 对于每个文件夹， .order 文件定义添加到父页的子页序列。
可以像从“代码>文件”页中添加任何文件一样添加 .order 文件。 将文件命名 为 .order。
然后，编辑文件的内容以反映文件夹中包含的 Markdown 文件序列。 每个条目都应镜像文件名，但没有 .md 文件类型。 标题区分大小写，因此条目应与文件名中使用的大小写匹配。
例如：
README
page-2
page-3
Page-4
Misc content
设置主页
默认情况下，按字母顺序显示在根目录中的第一个文件设置为 Wiki 主页。 每当在 Web 门户中选择 Wiki 时，主页将打开。
可以通过在根 .order 文件中设置页面序列来更改主页。
例如，将页面名称输入到第一行：
New home page name here
page-2
page-3
Page-4
README
Misc content
将文件夹提升到页面
要使文件夹成为页面，应该有一个与文件夹同名的 Markdown 文件，这意味着文件夹和同名 的 .md 文件应彼此相邻。
如以下示例所示，Test 具有一个文件夹和一个 .md 文件，该文件在 Wiki 树中创建层次结构。
