预配的 Wiki 与作为 Wiki 发布的代码
Azure DevOps Services |Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018
在 Azure DevOps 中,有以下用于维护 Wiki 内容的选项。
- 为团队项目预配 Wiki。 此选项仅支持团队项目的一个 Wiki。
- 将 Git 存储库中定义的 Markdown 文件发布到 Wiki。 使用此选项,可以维护多个版本控制 Wiki 以支持内容需求,尽管仅在启用Azure Repos时才可用。
虽然这两个选项都维护 Git 存储库中的 Wiki 内容,但添加、更新和管理 Wiki 内容的方式有所不同。
注意
发布代码作为 wiki 功能目前在 Azure DevOps Server 2018 及更高版本中提供。 对于较旧版本,只能 为团队项目预配 Wiki。
Wiki 页面菜单选项
使用 预配的 Wiki,可以直接在 Wiki 中添加和编辑页面。 对 预配的 Wiki 进行的所有内容更新都发生在 Wiki 中。
使用 发布代码作为 Wiki,可以从 Repos 或 Code 添加、编辑和更新内容。
下图显示了 Wiki 页面的不可用菜单选项。 如你所看到的,作为 代码 Wiki 页面的发布不支持多个选项。
预配的 Wiki
将代码发布为 Wiki
例如,发布代码的 “在存储库中编辑 ”选项,因为 wiki 将转到 存储库 页面以编辑该特定页面。 汇报你对为 Wiki 选择的分支中的页面自动发布到 Wiki。
支持的功能和操作差异
预配的 Wiki 并 发布为代码 Wiki 支持以下功能:
- Markdown 格式
- HTML 标记
- 插入和调整图像大小
- 数学表示法和字符
- Link to work items using #
- 附加文件
- 筛选 Wiki 内容
- 打印 Wiki 页面
- 脱机更新内容
- 从 Wiki 添加或编辑页面
下表汇总了可能有所不同的操作或功能,具体取决于 Wiki 类型。
操作 | 预配的 Wiki | 将代码发布为 Wiki |
---|---|---|
支持多个 Wiki,名称 wiki | ✔️ | |
从存储库>文件或代码>文件添加或编辑页面 | ✔️ | |
还原到 Wiki 的早期修订 | ✔️ | |
从 Repos 或 Code 还原到早期修订 | ✔️ | ✔️ |
维护版本控制 Wiki | ✔️ | |
选择 Wiki 版本 | ✔️ | |
取消发布 Wiki | ✔️ |
添加页面
对于 预配的 Wiki 或 将代码发布为 Wiki,请选择“ 新建”页 或 “添加子页”。 若要了解详细信息,请参阅 “添加和编辑 Wiki 页面”。
导航窗格中的页面序列和页面列表
预配的 Wiki 会在导航窗格中添加或移动页面时自动管理页面序列和页面列表。
若要将发布代码的导航窗格中的页面列表结构 为 wiki,请在根目录下定义 .order 文件,以及包含子页的每个子文件夹或父页。
这两种类型的 Wiki 都遵循相同的文件结构,只是作为 Wiki 的发布代码需要手动维护页面序列。
若要详细了解如何使用 .order 文件,请参阅 Wiki Git 存储库文件和文件结构。
页面修订并还原到以前的版本
在 Wiki 中,可以通过选择修订或选择“查看修订”菜单选项来查看任何 Wiki 页面的修订。
但是,还原过程因 Wiki 页面类型而异。
- 对于预配的 Wiki 页面,请选择“还原”,如还原提交到预配的 Wiki 页面中所述
- 对于 发布为代码 Wiki 页面,请从本地分支工作并提交拉取请求以更新正在处理的分支。
版本控制并取消发布 Wiki
使用版本控制,可以根据 Git 存储库的版本化分支将不同的内容版本发布到不同的 Wiki。 仅通过将代码发布到 Wiki 创建的 Wiki 支持版本控制以及取消发布之前发布到 Wiki 的内容。
若要了解详细信息,请参阅 版本、选择或取消发布已发布的 Wiki。
删除项目 Wiki
- 获取与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。 有关详细信息,请参阅 Wikis - 获取 REST API。
GET https://dev.azure.com/{organization}/{projec``t}/_apis/wiki/wikis/{wikiIdentifier}?api-version=6.0
还可以获取项目或集合中的所有 Wiki。 有关详细信息,请参阅 Wikis - 列出 REST API
- 删除与提供的 Wiki ID 或 Wiki 名称对应的 Wiki。 有关详细信息,请参阅 Wikis - 删除 REST API。
DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?api-version=6.0
通过脱机工作更新 Wiki
你可以脱机工作,也可以在本地分支中更新 预配 Wiki 的内容并 发布为代码 Wiki。 若要了解详细信息,请参阅 脱机克隆和更新 Wiki 页面。