通过

关于 Wiki、README 和 Markdown

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

可以使用 Markdown 向团队项目添加丰富的格式、表格和图像来支持团队和项目参与者。 Markdown 格式可以优化团队项目的 Wiki 页面、仪表板中的内容、团队项目的自述文件或其他存储库的自述文件。

设置项目维基

通过团队项目 Wiki，你可以与其他团队成员共享有关项目的信息。 从头开始设置 Wiki 时，新的 Git 存储库会存储 Markdown （.md） 文件、图像、附件和页面序列。 Wiki 支持对其内容和结构的协作编辑。

以下链接介绍了团队项目 Wiki 支持的功能。

创建新的 Wiki

使用维基内容

设置 wiki 内容格式

将 Git 存储库发布到 Wiki

许多团队使用 Markdown 文件来记录代码，并将其与代码一起签入存储库。 虽然 Git 支持使用标准拉取请求过程维护和查看代码文档文件，但这些文件可能会给内容的使用者带来挑战。

  • 用户通常必须筛选多个文件和文件夹才能找到感兴趣的内容。
  • 内容缺少组织和结构。 没有固有的页面层次结构来支持读者。
  • 不支持内容版本控制。
  • 搜索内容依赖于搜索代码，而不是针对搜索内容进行优化的搜索体验。

使用 发布代码作为 Wiki 功能，可以将团队项目中定义的一个或多个 Git 存储库发布到 Wiki。 此功能提供了一种与代码库同步维护代码文档的方法，并允许你选择性地将文档发布到 Wiki 并更新文档。

在团队项目的 Wiki 中管理内容与从 Git 存储库发布的 Wiki 网页之间存在重大差异。 有关详细信息，请参阅 将 Git 存储库发布到 Wiki。

使用 Markdown 增强项目内容

Markdown 格式可轻松设置文本格式和包含图像。 还可以链接到项目页面、自述文件、仪表板和拉取请求中的文档。

可以使用 Markdown 通过以下方式向团队提供指导：

有关支持的语法，请参阅 在 Azure DevOps 中使用 Markdown。

添加项目自述文件

可以为每个存储库或团队项目定义自述文件或多个文件。 在 Markdown 中编写自述文件，而不是纯文本。 使用自述文件页面将参与者定向到项目中的特定信息或位置。

请考虑添加以下指南：

  • 项目焦点
  • 先决条件
  • 设置环境
  • 有关在项目中完成操作的提示
  • 特定文件的用途或使用
  • 特定于项目的术语和首字母缩略词
  • 有关提交或上传更改和添加分支的工作流指南
  • 项目发起人或联系人

README 文件示例

下面是 GitHub 中项目 README 的一些示例，这些示例支持所有受众进行参考和灵感：