Azure DevOps Services |Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018
可以将已在 Git 存储库中维护的内容发布到 Wiki。 例如,此内容可以是软件开发工具包 (SDK) 支持、产品文档或自述文件。 还可以在单个团队项目中发布多个 Wiki。
本快速入门介绍如何执行以下任务:
打开 Wiki
将 Git 存储库发布到 Wiki
编辑已发布 Wiki 的页面
将页面添加到已发布的 Wiki
更改已发布 Wiki 的页面序列
使网页成为 Wiki 主页
将 Markdown 文件发布到 Wiki 时,可获得以下优势:
将内容组织到分层页面结构中
读者可以浏览和筛选的目录
发布新版本的内容
以管理代码库的相同方式管理内容
读者可以使用 Wiki 搜索功能轻松搜索 Wiki
有关管理不同 Wiki 类型的详细信息,请参阅
预配代码与作为 wiki 发布的代码
。
可以使用本文中所述的步骤添加和编辑已发布到 Wiki 的内容。 还可以脱机工作和更新 Wiki 内容,其方式与通过 Git 存储库协作处理代码的方式相同。 有关详细信息,请参阅
脱机更新 Wiki 页面
。
创建团队项目。 如果没有,请立即
创建一个项目
。
为项目启用Azure Repos服务。
在团队项目中定义 Git 存储库。 理想情况下,此存储库至少包含一个要发布到 Wiki 的 Markdown 文件。 有关详细信息,请参阅
在项目中创建新的 Git 存储库
。
具有
“贡献”
权限,以便将代码发布为 Wiki。 默认情况下,此权限是为
参与者组
的成员设置的。
有权参与 Git 存储库的任何人都可以添加或编辑 Wiki 页面。
打开 Wiki
(
https://dev.azure.com/{yourorganization}
) 登录到组织,打开项目,然后选择“
概述
>
Wiki
”。
如果要将存储库中的所有 Markdown 文件发布到 Wiki,请指定存储库的根目录。
选择“发布” 。 Wiki 存储库填充所选存储库中包含的 Markdown 文件和文件夹。
例如,下图显示了在步骤 2 中选择的 azure-docs-sdk-node 存储库中包含的文件的已发布存储库。
目录 (的 wiki 目录) 包含以下文件:
存储库/分支/文件夹中定义的每个 Markdown 文件 (文件类型=
.md
) 按字母顺序列出,TOC 标题派生自 Markdown 文件名。
已发布文件夹中定义的每个子文件夹的父页,即使它不包含任何 Markdown 文件。
下图显示了 azure-docs-sdk-node 存储库的内容。
可以使用
az devops wiki create
命令将 Git 存储库发布到 Wiki。 若要开始,请参阅
Azure DevOps CLI 入门
。 在现有 Git 存储库中维护 Markdown 文件,并且想要将其发布到 Wiki 时,请运行此命令。
如果项目尚未定义 Git 存储库,则无法将代码发布为 Wiki。 如有必要,
请创建新的 Git 存储库
,然后返回到此页面。
az devops wiki create [--mapped-path]
[--name]
[--org]
[--project]
[--repository]
[--type {codewiki, projectwiki}]
[--version]
mapped-path
:类型必需 codewiki
。 新 Wiki 的映射路径。 例如,可以指定要从存储库根目录发布的“/”。
name
:新 Wiki 的名称。
org
:Azure DevOps 组织 URL。 可以使用 命令配置默认组织 az devops configure -d organization=ORG_URL
。 如果未配置为默认值或使用 命令进行选取 git config
,则为必需。 例如 --org https://dev.azure.com/MyOrganizationName/
。
project
:项目的名称或 ID。 可以使用 命令配置默认项目 az devops configure -d project=NAME_OR_ID
。 如果未配置为默认值或使用 命令进行选取 git config
,则为必需。
repository
:类型必需 codewiki
。 要从中发布 Wiki 的存储库的名称或 ID。
type
:要创建的 Wiki 的类型。 接受的值 (projectwiki
默认) 和 codewiki
。
version
:类型必需 codewiki
。 要从中发布代码 Wiki 的存储库分支名称。
以下命令创建 codewiki
从 MyRepo
存储库发布的名为“My New Wiki”的 。 Wiki 在 分支的 wikis
文件夹中 main
发布,结果以表格式显示。
az devops wiki create --name "My New Wiki" --type codewiki --repository MyRepo --mapped-path /wikis --version main --output table
ID Name Type
------------------------------------ ----------- --------
77abd847-31ec-45e9-8622-a190df8e5917 My New Wiki codewiki
可以通过在选择发布到 Wiki 的分支上定义分支策略,以管理任何其他 Git 存储库的相同方式管理 Wiki 存储库。 但是,无需定义任何策略,即可进行更改,并从 Web 门户或客户端直接推送到分支。
使用编辑模式下提供的链接来预览更改或突出显示上一版本所做的更改。 若要放弃更改,请选择“ 取消”。 有关支持的 Markdown 功能的详细信息,请参阅 Markdown 用法的语法指南。
完成后,添加有关更新的注释,然后选择“ 提交”。
系统会自动显示用于创建拉取请求的链接。 直接编辑 Wiki 分支时,可以忽略此消息。
页面标题区分大小写,在文件夹中必须是唯一的,并且不超过 235 个字符。 有关其他游戏限制的详细信息,请参阅 页面标题命名限制。
可以从发布的文件夹中删除不希望显示在 Wiki 中的任何 Markdown 文件。 如果已将文件包含在文件中 .order
,请从 .order
该文件中删除其条目。 有关详细信息,请参阅 更改页面序列、添加或更新 .order 文件。
添加一个或多个页面
可以将以下页面添加到已发布的 Wiki:
从 Web 门户将文件添加到根文件夹或子文件夹
将文件上传到根文件夹或子文件夹
添加或更新 .order
文件以在 Wiki TOC 中指定页面序列
每次更新都需要将更改提交到存储库。 然后,可以刷新已发布存储库的 Wiki 以查看更改。
从 Web 门户添加页面
在已发布存储库的“存储库>文件”或“代码>文件”中,选择“操作”,然后选择“文件”。
输入页面的名称,确保指定 .md
文件类型。 文件名应对应于要在 TOC 中显示的页面标题,用短划线代替空格。 指定不超过 235 个字符的唯一标题。 页面标题区分大小写。 有关其他游戏限制的详细信息,请参阅 页面标题命名限制。
例如,若要添加在 TOC 中显示为 第 4 页的页面,请添加名为 Page-4.md
的文件。
添加或更新 .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 树中创建层次结构。
取消发布 Wiki 或选择版本
关注 Wiki 页面并获取通知
预配与已发布的 Wiki
脱机更新 Wiki
Wiki Markdown 指南