我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们
文章版本: Enterprise Server 2.15

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2019-10-16. 即使针对重大安全问题,也不会发布补丁。 For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

关于自述文件

您可以将自述文件添加到仓库,告知其他人您的项目为什么有用,他们可以对您的项目做什么,以及他们可以如何使用。

自述文件连同、仓库许可证参与指南一起,帮助您,沟通项目要求以及管理对项目的参与。

自述文件通常是访问者在访问仓库时看到的第一个项目。 自述文件通常包含以下信息:

如果将自述文件放在仓库的根目录 docs 或隐藏的目录 .github 中,GitHub Enterprise 将会识别您的自述文件并自动向仓库访问者显示。

Github/scientist 仓库的主页面及其自述文件

许多项目使用目录和自述文件的开头将用户导向文件的不同章节。 通过将鼠标悬停在章节标题的上方以显示链接,您可以直接链接到渲染文件中的章节:

github/scientist 仓库自述文件中的章节链接

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub Enterprise will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. You can use all relative link operands, such as ./ and ../.

Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.

延伸阅读

问问别人

找不到要找的内容?

联系我们