脱机克隆和更新 Wiki 内容

  • 项目

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

可以脱机更新 Wiki 页面，就像在 Git 存储库中开发代码一样。

可以使用所需的任何客户端或 git 命令行工具脱机更新 Wiki。 有关使用 Git 存储库和支持的工具的详细信息，请参阅 Git 存储库。

脱机更新 Wiki 内容的基本步骤如下：

  1. 将 Wiki Git 存储库克隆到本地 IDE 或工作区。
  2. 将文件或文件夹添加到本地 git 分支。
  3. 更新 .order 文件以反映页面和子页。
  4. 提交更新并将其推送到本地 git 分支。

先决条件

执行以下步骤，将 Markdown 页面从另一个 Wiki 迁移到团队项目 Wiki，或将你发布为代码的内容迁移到 Wiki。

克隆 Wiki

Wiki 存储库存储页面、图像、附件以及页面和子页的顺序。 克隆 Wiki 以开始。

  1. 登录到项目（https://dev.azure.com/{Your_Organization/Your_Project}），然后选择 Wiki。

  2. 打开“更多操作”上下文菜单，然后选择“克隆 Wiki”。

    克隆 Wiki Git 存储库

  3. 在“克隆存储库”对话框中，选择“将克隆 URL 复制到剪贴板”。

    复制 Wiki URL

    在浏览器中输入它以查看 wikiMaster 分支下定义的文件。

    Wiki 主文件

  4. 使用复制的 URL 在使用的 IDE 中克隆存储库。 有关详细信息，请参阅以下文章之一：

将页面添加到本地 Git 存储库

我们使用 Markdown 格式创作页面。 将 Markdown 文件添加到要添加到 Wiki 的每个页面和子页面的本地分支。

添加页面

若要在 Wiki 树的根目录中添加页面，请在 Git 存储库的根目录中添加 Markdown 文件。

  1. 对于要添加的每个页面，创建一个包含页面内容的 Markdown 文件，然后将其添加到存储库的根文件夹下。

    对于 CanaryBuilds 团队项目，它位于以下文件夹中：

    C:\Users\UserName\Source\Repos\CanaryBuilds.wiki

  2. 若要在 Wiki 树的根目录中添加页面，请在 Git 存储库的根目录中为每个页面添加 Markdown 文件。

    本地分支 Wiki Git 存储库

  3. 在添加要添加到根目录的所有页面后，更新根目录中的 .order 文件。 对于根目录定义的每个 Markdown 文件，它应该有一个条目。 每个条目都应将文件标题与替换为短划线的空格匹配。

    例如：

     Welcome
 Roadmap  
 How-to-contribute  
 Home  
 Reference

添加子页

  1. 为父页创建一个文件夹，然后为文件夹中的每个子页添加 Markdown 文件。

    例如，我们向操作说明文件夹添加了以下文件。 这些子页显示在 Wiki 中的“如何参与”页面下。

    子页的屏幕截图。

  2. 在文件夹中添加一个 .order 文件，其中包含子页的顺序，因为它们应出现在 Wiki 中。 若要了解如何使用 .order 文件对页面进行排序，请参阅 Wiki Git 存储库文件和文件结构。

    例如，该文件具有以下子页：

     Request-extensions  
 Licensing  
 Smoke-test  
 Coding-guidelines

推送你的更改

完成所有更新后， 将文件推送到 Git 存储库。

添加的页面和子页立即显示在 Wiki 中。

Wiki 树已更新

如果进程中有任何错误，页面会显示在 Wiki 中，并带有警告符号。

当 .order 文件未正确更新时发出警告。