添加和编辑 Wiki 页面

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

为团队项目设置 Wiki Git 存储库 后,可以为 Wiki 和页面内容添加标题。 Azure DevOps UI 提供并行体验,可在其中编辑页面,并在工作时预览更改。

“编辑 ”窗格中,使用 Markdown 格式语法输入页面内容。 还可以插入图像、附件和链接。 进行更改时,内容将在 “预览 ”窗格中更新。 具有特殊格式的内容(如标题、列表、链接和图像)在 “预览 ”窗格中显示为格式文本。

Azure DevOps 中 Wiki 主页的屏幕截图,其中显示了可同时编辑页面内容和预览更改的并行体验。

编辑页面时,使用 Ctrl+S 键盘快捷方式快速保存工作。 还可以使用自定义修订消息(如“已添加页面链接”)保存工作。此选项在 “保存 ”下拉菜单中可用:

显示如何在 Azure DevOps 中选择“使用修订消息保存”选项的屏幕截图。

其他键盘快捷方式可用。 有关详细信息,请参阅 用于管理 Wiki 页面的键盘快捷方式

注意

本文介绍如何在为团队项目创建的 Wiki 中添加和编辑页面。 如果要向从 Git 存储库发布的 Wiki 添加或编辑页面,请参阅 将 Git 存储库发布到 Wiki

Wiki 命令行工具

可以使用 Azure DevOps CLI 命令管理 Wiki 内容。 下表提供了本文中介绍如何使用特定命令的部分的链接。

指令 说明
az devops wiki show 打开 Wiki 并显示 Wiki 主页。
az devops wiki page show 在 Wiki 中显示特定页面。
az devops wiki 页面创建 向 Wiki 添加新页面。
az DevOps Wiki页面更新 编辑 Wiki 中的现有页面。
az devops wiki 页面删除 删除 Wiki 中的页面。

先决条件

类别 要求
项目访问权限 Wiki 所在的项目的成员。 你可以根据需要从项目管理员请求访问权限。
权限 属于 贡献者 组的成员。
访问级别 至少具有基本访问权限。
任务 为项目准备 预配的 Wiki

打开 Wiki

可以在浏览器中从 Azure DevOps 打开并查看团队项目的 Wiki 页面,也可以使用 Azure DevOps CLI。

使用 受支持的 Web 浏览器 连接到项目,然后选择 Wiki

浏览器中打开 Wiki 的屏幕截图,其中显示了 Wiki 概述页。

如果需要切换团队项目,请选择 Azure DevOps浏览所有团队项目和团队

添加 Wiki 页面

本部分介绍如何向 Wiki 添加页面。 可以直接在浏览器中使用 Azure DevOps UI,也可以使用 Azure DevOps CLI。

若要向 Wiki 添加新页面,有两个选项。 首先在列表中选择一个页面,例如主页。

  • 若要在与当前页相同的级别添加页面,请选择 Azure DevOps UI 底部的 “新建”页

  • 若要将子页添加到当前页,请选择 “更多选项 ”(...) >添加子页

显示如何在 Azure DevOps 中向 Wiki 添加新页面或新子页的屏幕截图。

还可以使用键盘快捷方式添加页面。 选择当前页,然后通过选择 n 或通过选择 c 添加子页来添加新页面。 有关详细信息,请参阅 用于管理 Wiki 页面的键盘快捷方式

页面标题和文件名

输入页面的唯一标题。 该值区分大小写。 标题用作页面的文件名。 在文件名中,页面标题中的空格将替换为连字符(-)。 例如,页面标题“如何参与”对应于文件名 How-to-contribute.md。 文件的完全限定路径应为 235 个字符或更少。

有关其他文件名限制,请参阅 Wiki Git 存储库文件和文件结构、文件命名约定

页面标题和文件名限制

每个 Wiki 页面对应于 Wiki Git 存储库中的一个文件。 以下限制适用于页面文件名和文件大小:

  • 文件名:为页面文件选择名称时,请记住,文件的完全限定路径应为 235 个字符或更少。 页面的完整路径包括存储库 URL、页面文件的文件夹路径和页面文件名。 例如,https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md

  • 唯一性:页面文件名在其 Wiki 存储库层次结构中的文件夹位置内必须是唯一的。 名称区分大小写。

  • 特殊字符:页面文件名对以下特殊字符有限制:

    • 无 Unicode 控制字符或代理字符
    • 无可打印字符:正斜杠、反斜杠/\、哈希#
    • 名称开头或结尾处没有句点 . 符号
  • 文件大小:最大页面文件大小为 18 MB。

  • 附件文件大小:页面文件的任何附件的最大大小为 19 MB。

允许的特殊字符

页文件名中允许使用多个特殊字符,例如冒号 : 和连字符 -。 例如,可以将 Markdown 文件命名为 FAQ:0525Setup-Guide

重要

若要避免页面语法和浏览器导航中的错误,请勿在页面文件名中使用空格字符( )。 如果基于页面标题命名页面文件,请将页面标题中的任何空格替换为文件名中的连字符(-)。

下表列出了 Wiki 页面文件名中允许的特殊字符和相应的 URI 编码字符串:

字符 符号 URI 字符串
结肠 : %3A
左尖括号 < %3C
右尖括号 > %3E
星号通配符 * %2A
问号 ? %3F
管道 | %7C
连字符短划线 - %2D
双引号 " %22

例如,文件名 FAQ:0525 编码为 FAQ%3A0525

设置 Wiki 主页

默认情况下,在创建 Wiki 时添加的第一个页面设置为 Wiki 主页。 如果其他页面更相关,则可以更改 Wiki 主页。 有关详细信息,请参阅 重新排序或移动 Wiki 页面

编辑和删除 Wiki 页面

本部分介绍如何在 Wiki 中编辑或删除页面。 可以直接在浏览器中使用 Azure DevOps UI,也可以使用 Azure DevOps CLI。

可通过多种方式在浏览器中编辑现有 Wiki 页面:

  • 打开 Wiki 页面,然后选择“ 编辑”。
  • 打开 Wiki 页面并使用键盘快捷方式 e.
  • 在页面列表中选择 Wiki 页面,然后选择 “更多选项 ”(...) >编辑

有关特定编辑函数的详细信息,请参阅 使用 Markdown 指南

在 Repos 中编辑代码 Wiki

将代码发布为 Wiki 时,可以在 Repos 中心编辑 Wiki 页面。 Markdown 工具栏格式设置选项提供了相同的并行编辑器体验。 选择编辑>在 Repos 中编辑以创建分支并继续编辑:

显示如何在 Azure DevOps 中选择“编辑存储库”选项的屏幕截图。

「在存储库中编辑」选项仅适用于启用了分支策略的代码维基。 如果未看到该选项,可能是因为 Wiki 不是代码 Wiki 或未启用分支策略。 有关详细信息,请参阅分支策略和设置

在浏览器中删除 Wiki 页面

若要删除 Wiki 页面,请在页面列表中选择 Wiki 页面,然后选择 “更多选项 ”(...) >删除。 还可以从页面的右键单击菜单中选择“ 删除 ”。

选择“ 删除”后,确认对话框中的删除。

注意

删除 Wiki 页面时,还会删除页面的所有元数据以及附加到该页面的任何子页。

重新排序或移动 Wiki 页面

在浏览器中,可以在 Wiki 树视图中对页面重新排序,以便页面以首选序列显示。 默认序列按文件名按字母顺序排列。 可以按文章、类别或预期受众更改序列以对页面进行重新排序。

在树视图中的页面标题上可以使用拖放操作来完成以下任务:

  • 移动:更改页面的页面/子页关系。 如果在 Wiki 序列中移动页面,则指向来自其他 Wiki 页面的页面的链接可能会中断。 移动页面后,可以手动 修复这些链接

  • 重新排序:更改 Wiki 序列中页面的顺序。 重新排序 Wiki 序列中的页面不会影响页面链接。

若要在 Wiki 序列中移动页面后修复中断的链接,请执行以下步骤:

  1. 测试 Wiki 中的其他页面,并查找指向已移动页面的链接。

    检查页面上是否有错误消息或缺少内容。

  2. 打开具有断开链接的页面,选择 “编辑”,然后转到页面内容中的断开链接。

    若要在内容中查找断开的链接,可以搜索已移动页面的名称、移动页的原始文件路径或断开链接的链接文本。

  3. 更新中断的链接。 典型的解决方法是更改链接中的 URL 或路径,以定位移动页面的新位置。

  4. 保存对页面所做的更改,以便链接更新。

  5. 在浏览器中打开更新的页面并测试链接。 确认它已成功打开移动的页面。

更改顶级页面的顺序

可以使用键盘快捷方式对 Wiki 序列中的顶级页面重新排序。 此操作不适用于子页。

在 Wiki 页面列表中选择一个页面,并使用 CTRL + 向上键Ctrl + 向下键 快捷方式移动序列中的页面。 更改会立即应用。

更改页面/子页顺序

还可以更改 Wiki 序列中任何页面的页面/子页面顺序。

  1. 选择要在 Wiki 页面列表中移动的页面。

  2. 选择 更多选项...) >移动,这将打开 “移动”页 对话框。

  3. “移动页 ”对话框中,选择要用作新 页的页面。

    显示如何移动 Wiki 页面的屏幕截图,使其成为序列中另一页的子页。

  4. 选择新的父页后,系统会根据页面移动扫描任何潜在的损坏链接。 它报告需要调整的链接:

    显示如何让系统调整 Wiki 序列中页面移动导致的任何页面链接的屏幕截图。

  5. 页面和工作项中选择“更新受影响的链接” 选项,然后选择“ 移动 ”以完成页面移动。

有关键盘快捷方式的完整列表,请参阅 用于管理 Wiki 页面的键盘快捷方式