跳至主要内容

添加或编辑维基页面

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

谁可以使用此功能?

维基在使用 GitHub Free(以及面向组织的 GitHub Free)的公共仓库中可用,也在使用 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. 在页面的右上角,单击 New Page

  4. 可选地,要使用非 Markdown 的格式编写,请使用“Edit mode”下拉菜单选择其他格式。

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

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

  6. 在 “Edit message” 字段中,键入描述您正在添加的新文件的提交信息。

  7. 要将更改提交到 wiki,请单击 Save Page

编辑 wiki 页面

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在您的仓库名称下,点击 Wiki

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

  3. 使用右侧的 wiki 侧边栏,导航至您想更改的页面。在页面右上角,单击 Edit

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

  5. 在 “Edit message” 字段中,键入描述您所做更改的提交信息。

  6. 要将更改提交到 wiki,请单击 Save Page

在本地添加或编辑 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.mdfoo.markdown,wiki 将使用 Markdown 转换器,而文件名为 foo.textile 的则会使用 Textile 转换器。

不要在 wiki 页面标题中使用以下字符:\ / : * ? " < > |。某些操作系统的用户将无法使用包含这些字符的文件名。请确保使用与文件扩展名匹配的标记语言编写内容,否则内容将无法正确渲染。

© . This site is unofficial and not affiliated with GitHub, Inc.