Skip to main content

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

About wikis

You can host documentation for your repository in a wiki, so that others can use and contribute to your project.

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

Every repository on your GitHub Enterprise Server instance comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "About READMEs."

With wikis, you can write content just like everywhere else on GitHub Enterprise Server. For more information, see "Getting started with writing and formatting on GitHub." We use our open-source Markup library to convert different formats into HTML, so you can choose to write in Markdown or any other supported format.

If you create a wiki in a public repository, the wiki is available to anyone with access to your GitHub Enterprise Server instance. If you create a wiki in a private or internal repository, only people with access to the repository can access the wiki. For more information, see "Setting repository visibility."

You can edit wikis directly on GitHub Enterprise Server, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on your GitHub Enterprise Server instance to contribute to a wiki in a public repository. For more information, see "Changing access permissions for wikis."

Note: Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use GitHub Pages in a public repository.

Further reading