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

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2019-07-12. 即使出现严重安全问题,也不会发布补丁。要获得更好的性能、更高的安全性和全新功能,请升级到 GitHub Enterprise 的最新版本。 要获取有关升级的帮助,请联系 GitHub Enterprise 支持部门

关于自述文件

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

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

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

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

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

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

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

您可以在渲染文件中定义相对链接和图像路径,以帮助读者导航到仓库中的其他文件。

相对链接是相对于当前文件的链接。例如,如果仓库的根目录中有自述文件,docs / CONTRIBUTING.md 中有另一个文件,则自述文件中 CONTRIBUTING.md 的相对链接可能如下所示:

[此项目的参与指南](docs/CONTRIBUTING.md)

GitHub Enterprise 会根据您当前所在的分支自动转换相对链接或图像路径,使链接或路径始终有效。您可以使用所有的相对链接操作数,例如 ./../

克隆仓库的用户更容易访问相对链接。绝对链接在仓库的克隆中可能无效 - 我们建议使用相对链接来引用仓库中的其他文件。

延伸阅读

问问别人

找不到要找的内容?

联系我们