Home

about-github-wikis翻译中英对照

About GitHub Wikis

集囗^trans-name（GitHub）维基简介

Just as writing good code and great tests are important, excellent documentation helps others use and extend your project.

书写良好的代码和测试用例，既方便他人使用项目，也有助他人在该项目基础上继续开发；撰写优异的项目文档，同样可达此目的。

Every GitHub repository comes equipped with a section for hosting documentation, called a wiki.

每一个github代码仓库都留有一个存储文档的地方，名为wiki。

GitHub Wikis are a place in your repository where you can share long-form content about your project, such as how to use it, how it's been designed, manifestos on its core principles, and so on. Whereas a README is intended to quickly orient readers as to what your project can do, wikis can be used to provide additional documentation.

github wiki是代码仓库中的一个地方，项目作者可以将项目内容详述于此，如项目使用说明、项目设计思路、项目核心理念等。 README是快速上手指南（内容相对简略），而wiki可以补充，提供更为丰富详细的说明文档。

With wikis, you can write content just like everywhere else on GitHub. We use our open-source Markup library to convert different formats into HTML, so you can choose to write in Markdown, RST, Textile, or any other supported format when you craft wiki pages.

撰写wiki，与撰写github其他内容并无二致。 作者撰写wiki时，可以选用Markdonw, RST,Textile等语法， github wiki的开源标记语言函数库会将这些语法格式转换成HTML，显示在浏览器页面中。

Wikis can be edited directly on GitHub, or you can work with a text editor offline and simply push your changes. Wikis are collaborative by design. By default, only collaborators on your repository can make changes to wikis, but you can configure this to be enabled for all users on public repositories.

项目作者可以在github上直接编辑wiki，也可以离线编辑，然后push编辑的内容。wiki的设计理念鼓励作者们合作编撰。 一般，只允许代码仓库的合作人员编撰wiki内容，但项目作者可以修改配置，允许所有访问者编撰公开代码仓库的wiki内容。