添加或编辑 Wiki 页面

您可以直接在 GitHub 上或使用命令行在本地添加和编辑 Wiki 页面。

谁可以使用此功能？

Wiki 可用于具有 GitHub Free 和 GitHub Free for organizations 的公共代码库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有代码库。有关更多信息，请参阅“GitHub 的计划”。

本文内容

添加 Wiki 页面

  1. 在 GitHub 上，导航到代码库的主页。

  2. 在您的代码库名称下，单击 Wiki.

    Screenshot of the menu in a repository. The "Wiki" option is outlined in dark orange.

  3. 在页面右上角，单击**新建页面**。

  4. 可选：要使用 Markdown 以外的格式进行编写，请使用“编辑模式”下拉菜单选择其他格式。

    Screenshot of the "Create new page" page. The "Edit mode" dropdown is outlined in dark orange.

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

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

  7. 要将更改提交到 Wiki，请单击**保存页面**。

编辑 Wiki 页面

  1. 在 GitHub 上，导航到代码库的主页。

  2. 在您的代码库名称下，单击 Wiki.

    Screenshot of the menu in a repository. The "Wiki" option is outlined in dark orange.

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

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

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

  6. 要将更改提交到 Wiki，请单击**保存页面**。

在本地添加或编辑 Wiki 页面

Wiki 是 Git 代码库的一部分，因此您可以进行本地更改并使用 Git 工作流将它们推送到您的代码库。

将 Wiki 克隆到您的计算机

每个 Wiki 都提供了一种简单的方法，可以将其内容克隆到您的计算机。在 GitHub 上创建初始页面后，您可以使用提供的 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 页面的标题中使用以下字符：\ / : * ? " < > |。某些操作系统的用户将无法使用包含这些字符的文件名。请确保使用与扩展名匹配的标记语言编写内容，否则您的内容将无法正确呈现。