Wiki 文件和文件结构

  • 项目

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

了解项目 Wiki 和代码 Wiki 的文件和文件结构。 以下指南可能指定代码 Wiki，但它适用于这两种类型的 Wiki。

创建团队项目时，默认情况下不会创建 Wiki。 有关详细信息，请参阅 “创建 Wiki”、“ 创建自述文件”或 “预配的 Wiki”，以及发布代码作为 Wiki。

每个代码 Wiki 都由后端中的 Git 存储库提供支持。 此存储库存储 Markdown 页面、图像、附件以及页面和子页的顺序。 通过 Azure DevOps 用户界面创建 Wiki，然后可以通过 Git 存储库 URL 路径编辑 Wiki。 有关发布代码 Wiki 的详细信息，请参阅 将 Git 存储库发布到 Wiki。

Wiki 文件和文件夹结构

为团队项目 wiki Git 存储库分配了以下标签。

  • 团队项目的 Wiki 存储库： ProjectName.wiki
  • 主分支： wikiMain

通过定义 wikiMain 分支上的分支策略，以管理任何其他 Git 存储库的方式管理 Wiki 存储库。 但是，你可以对本地 wikiMain 分支进行更改，并将其直接推送到远程分支，而无需定义任何策略。

Wiki 存储库具有以下文件和文件夹：

  • 在根级别输入的每个 Markdown 页面的文件
  • 在根文件夹和每个文件夹下标记 .order 的文件
  • 包含子页的每个页面的文件夹
  • .attachments 文件夹，存储 Wiki 的所有附件

文件命名约定

每个文件都需要在页面标题中使用连字符而不是空格。 例如， 如何参与 页面标题对应于 How-to-contribute.md 文件名。 页面名称将添加到 URL，确保在 Wiki 随时间推移变化时，你共享的链接保持不变。

每个 Wiki 页面对应于 Wiki Git 存储库中的一个文件。 分配给 Wiki 页面标题的名称必须符合以下限制。

限制类型 限制
文件名 完全限定的页面路径不应超过 235 个字符。
唯一性 页面标题区分大小写，在 Wiki 层次结构中必须是唯一的。
特殊字符 - 不得包含任何 Unicode 控制字符或代理字符。
- 不得包含以下可打印字符： / \ #。
- 不得以句点 .开头或结尾。
文件大小 不得超过最大 18 MB。
附件文件大小 不得超过最大 19 MB。

Wiki 页面标题中的特殊字符

可以指定包含一个或多个这些特殊字符 : < > * ? | -的页面标题。 例如，可以将 Markdown 文件命名为“FAQ？”或“设置指南”。 这些字符具有以下 URI 编码字符串：

字符 编码字符串
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

.order 文件

.order 文件定义 Wiki 中的页面序列。 以下视觉对象显示了 Wiki TOC 的示例，以及相应的 .order 文件。

Wiki TOC .order 文件
Wiki TOC 示例的屏幕截图。 Wiki 示例订单文件的屏幕截图。

默认层次结构按字母顺序排列，但你可以在 .order 文件中更改此层次结构。 有关如何对 Wiki 页面重新排序的详细信息，请参阅 添加和编辑 Wiki 网页、重新排序 Wiki 页面。

删除 .order 文件以还原按字母顺序排序

如果没有 .order 文件，页面将按字母顺序排序。 若要还原按字母顺序排序，请执行以下步骤：

  1. 复制 Wiki 的克隆 URL，并在浏览器中将其打开。 这样做会打开 git 存储库 (文件中心) ，该中心支持 wiki。
  2. 转到 .order 文件并将其删除。 文件在删除后自动（重新创建），例如，在项目上的拖放操作中。