Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2024-08-29. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

添加或编辑 wiki 页面

您可以直接在 GitHub Enterprise Server 或者本地使用命令行添加和编辑 wiki 页面。

谁可以使用此功能?

Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共存储库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和专用存储库。

添加 wiki 页面

  1. 在 你的 GitHub Enterprise Server 实例 上,导航到存储库的主页。

  2. 在存储库名称下,单击“ Wiki”。

    存储库中菜单的屏幕截图。 “Wiki”选项用深橙色框标出。

  3. 在页面的右上角,单击“新页面”。

  4. 或者,要以 Markdown 以外的其他格式写入,请使用“编辑模式”下拉列表以选择其他格式。

    “新建页面”页的屏幕截图。 “编辑模式”下拉列表用深橙色框标出。

  5. 使用文本编辑器添加页面内容。

  6. 在“编辑消息”字段中,键入描述要添加的新文件的提交消息。

  7. 要将更改提交到 Wiki,请单击“保存页面”。

编辑 wiki 页面

  1. 在 你的 GitHub Enterprise Server 实例 上,导航到存储库的主页。

  2. 在存储库名称下,单击“ Wiki”。

    存储库中菜单的屏幕截图。 “Wiki”选项用深橙色框标出。

  3. 使用右侧的 Wiki 边栏,导航到要更改的页面。 在页面的右上角,单击“编辑”。

  4. 使用文本编辑器编辑页面内容。

  5. 在“编辑消息”字段中,键入描述要添加的新文件的提交消息。

  6. 要将更改提交到 Wiki,请单击“保存页面”。

本地添加或编辑 wiki 页面

Wiki 是 Git 仓库的一部分,因此您可以在本地进行更改,然后使用 Git 工作流程将它们推送到仓库。

克隆 wiki 到计算机

每个 wiki 都提供一种将其内容克隆到计算机的简易方式。 在 GitHub Enterprise Server 上创建初始页面后,可以使用提供的 URL 将存储库克隆到计算机:

$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.wiki.git
# Clones the wiki locally

在克隆 wiki 后,可以添加新文件、编辑现有文件以及提交更改。 您与协作者在操作 wiki 时可以创建分支,但只有推送到默认分支的更改才会生效并供读者使用。

关于 wiki 文件名

文件名确定 wiki 页面的标题,文件扩展名确定 wiki 内容如何呈现。

Wiki 使用开放源代码 Markup 库转换标记,它根据文件扩展名确定要使用的转换器。 例如,如果将文件命名为 foo.md 或 foo.markdown,Wiki 将会使用 Markdown 转换器,而名为 foo.textile 的文件将使用 Textile 转换器 。

请勿在 Wiki 页面标题中使用以下字符:\ / : * ? " < > |。 有些操作系统的用户不能使用包含这些字符的文件名。 请确保使用符合扩展名的标记语言编写内容,否则您的内容无法正确呈现。