黑马程序员技术交流社区

标题: 在GitHub官网上如何记录项目 [打印本页]
作者: 庭院深深深几许    时间: 2019-4-19 14:54
标题: 在GitHub官网上如何记录项目
良好的文档是任何项目成功的关键。使文档可访问使人们能够了解项目; 使更新变得容易，确保文档保持相关性。
记录项目的两种常用方法是README文件和wiki：
README文件是其他用户更快速，更简单地了解您的工作的方法。
GitHub上的Wiki可帮助您以有用的方式提供有关项目的深入信息。
至少在你的项目中有一个README是个好主意，因为这是许多人第一次找到你的作品时会读到的东西。
创建自述文件
当你创建一个新的存储库，虽然GitHub上，选择“初始化这个资源库和自述”，除非你打算导入现有的资源库。

您的README.md文件现在可以在全新的存储库中进行编辑。您的项目名称位于顶部，后面是您在创建存储库时选择包含的任何描述。自述文件很容易在GitHub或本地修改。查看Mastering Markdown指南，了解有关如何在创建文件后修改文本的详细信息。
格式化README
自述文件通常遵循一种格式，以便立即将开发人员定位到项目的最重要方面。
项目名称：您的项目名称是人们在向下滚动到自述文件时会看到的第一个名称，并且在创建自述文件时包含在内。
描述：您的项目描述如下。一个好的描述是清楚，简短，重点。描述项目的重要性及其作用。
目录：可选地，包括一个目录，以便其他人快速浏览特别长或详细的自述文件。
安装：安装是有效自述文件的下一部分。告诉其他用户如何在本地安装项目。（可选）包含一个gif，以使其他人更清楚。
用法：下一部分是用法，在其中指导其他人在安装项目后如何使用项目。这也是一个包含项目截图的好地方。
贡献：较大的项目通常有关于为其项目做出贡献的部分，其中概述了贡献说明。有时，这是一个单独的文件。如果您有特定的贡献偏好，请解释它们，以便其他开发人员知道如何最好地为您的工作做出贡献。要了解有关如何帮助其他人贡献的更多信息，请查看为存储库贡献者设置指南的指南。
学分：包括学分部分，以突出显示并链接到您项目的作者。
许可证：最后，包括项目许可证的部分。有关选择许可证的更多信息，请查看GitHub的许可指南！
您的自述文件应仅包含开发人员开始使用和为您的项目做出贡献的必要信息。更长的文档最适合wiki，如下所述。
创建你的wiki
GitHub上的每个存储库都附带一个wiki。创建存储库后，您可以通过侧栏导航设置包含的Wiki。启动维基只需单击维基按钮并创建第一页即可。

添加内容
Wiki内容旨在轻松编辑。您可以通过单击每页右上角的“ 编辑”按钮在任何Wiki页面上添加或更改内容。这打开了wiki编辑器。

Wiki页面可以用GitHub Markup支持的任何格式编写。使用编辑器中的下拉菜单，您可以选择Wiki的格式，然后使用wiki工具栏在页面上创建和包含内容。Wikis还为您提供了包含自定义页脚的选项，您可以在其中列出项目的联系人详细信息或许可证信息。
GitHub会跟踪维基中每个页面所做的更改。在页面标题下方，除了对页面进行的提交数量外，您还可以看到谁进行了最新的编辑。单击此信息将转到完整页面历史记录，您可以在其中比较修订版本或查看详细的编辑列表。
添加页面
您可以通过选择右上角的“ 新建页面”向Wiki添加其他页面。默认情况下，您创建的每个页面都会自动包含在您的wiki侧边栏中，并按字母顺序列出。

您还可以通过单击添加自定义侧边栏链接向Wiki添加自定义侧边栏。自定义侧边栏内容可以包括文本，图像和链接。
注意：名为“Home”的页面用作Wiki的入口页面。如果缺少，则会显示自动生成的目录
语法突出显示
Wiki页面支持使用以下语法自动语法突出显示各种语言的代码：

```ruby
  def foo
    puts 'bar'
  end
```
该块必须以三个反引号开始，可选地后跟该块包含的语言的名称。有关可以语法突出显示的语言列表，请参阅Pygments。

块内容应缩进到与开始反引号相同的级别。该区块最后必须以与开口反推的相同级别缩进三个反推。





　　传智的web前端培训课程一直紧随市场发展脚步，实时更新前沿、深度、覆盖面广的前端课程。
　　传智全新升级的前端与移动开发课程新增了大热的小程序+小游戏、人脸识别、机器学习、大数据可视化等前沿技术，还加入了前所未有的全终端大型项目，让学员通过一个大型项目掌握从需求到开发再到上线部署的各项技能，为学员高薪就业增加砝码。
　　更多的相关web前端培训课程请访问：http://www.itcast.cn/web/




欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2