Github 是如何使用 Github 来处理 Github 文档的

提供书写良好的文档,可以帮助人们理解并很好地使用你的项目,而且人们还能够很容易地参与你的项目并作出贡献,但这仍不够。基于文档服务的底层系统能够使任何人——包括你或你的团队写文档更轻松。

文章转载自 开源中国社区 [http://www.oschina.net]

时间: 2024-12-23 18:50:39

Github 是如何使用 Github 来处理 Github 文档的的相关文章

使用 Github Pages 发布你的项目文档

你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程. 在

GitHub调查开源项目:文档、许可证书、在工作中的使用情况

GitHub对开源项目进行了一个调查,在对所收集的数据进行分析后,发布了结果.他们感兴趣的内容包括:开发人员跟开源项目之间是什么关系.文档扮演了什么样的角色.项目中出现的消极互动的程度和影响. 调查的组织者把调查结果归纳如下: 文档很重要,是建立包容.便利的社区的一种手段,但经常被忽视. 消极的交互不常发生但很醒目,会影响项目的活跃度. 全世界都在用开源项目,但其贡献者尚未体现其广泛的受众群体. 使用开源项目和对其做出贡献经常是在工作过程中发生的. 开源项目是软件选型时的默认选择.在开源项目遇到

Git与GitHub学习笔记(六)使用 Github Pages 管理项目文档

前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程

【Github教程】史上最全github使用方法:github入门到精通

原文转载自:http://www.eoeandroid.com/thread-274556-1-1.html [初识Github] 首先让我们大家一起喊一句"Hello Github".YEAH!就是这样. Git是一个分布式的版本控制系统,最初由Linus Torvalds编写,用作Linux内核代码的管理.在推出后,Git在其它项目中也取得了很大成功,尤其是在Ruby社区中.目前,包括Rubinius和Merb在内的很多知名项目都使用了Git.Git同样可以被诸如Capistran

Github Atom开源文本代码编辑器- 由 Github 打造的下一代编程开发利器

个人理解:Github 热度超凡的一个项目Atom,electron是整个atom的核心,对于electron可以理解成 electron =io.js + Chromium    通过 Electron 可以方便的打造基于Web,跨平台的Desktop应用.基于Web的native的接口,得益于io.js的封装,让本来没有本地权限的web能有原生native的权限,Chromium是呈现Web的跨平台基础,这样的完美结合,我们可以将HTML5 CSS JavaScript(AngularJS,

GitHub 推出购买和发现应用的 GitHub 市场

流行源代码托管平台 GitHub 宣布了一个购买和发现应用的市场 GitHub Marketplace,向开发者提供工具改进和定制工作流. 首批提供的开发工具包括了 Travis CI.Appveyor.Waffle,.ZenHub.Sentry 和 Codacy. GitHub 同时还宣布了: GitHub Apps(预览版):作为第一级的角色,GitHub Apps 通过 API 直接操作而无需使用用户身份模拟,并且还具有精细的权限,只访问所需的内容.将它们安装在组织或用户帐户上,然后让它们

GitHub下MD文档文件的使用

GitHub工具的安装   http://msysgit.github.com/ 主要有两个版本Windows和其他的平台   .md文件  http://markdownpad.com/download/ 查看工具下载 https://github.com/nicolahery/markdownpad-github  md文件对应的css  

从Wordpress迁移到Github

迁移原因 Git:自从使用了Git作为版本控制工具之后就爱上它了,相对SVN来说优势的确不少(虽然也有人批评,但凡事都有两面性,这里不予评价):www.wsria.com 是从2009年初用Wordpress创建的,一直是以WEB开发为主要方向,但是最近因为工作和学习时间导致更新缓慢:正好wsria的主机马上就到期所以决定使用Github+Markdown+Jekyll方式搭建博客,这样既能保证博客不会出现异常(断网等情况)又可以使用Git做版本控制,而且还可以像Geek一样写博客. 域名:因为

在GitHub上最受欢迎的大多是库或框架

我们发现,在GitHub上最受欢迎的项目中有60%是库或框架.在2017年一月份,我们手动地对5000个在GitHub上打星最多的开源项目进行了分类.结果如下图所示. 前三大领域是库和框架(1,535个存储库,30.7%),非Web库和框架(1,439个存储库,28.7%)和软件工具(972个存储库,占19.4%). 以下是我们的统计: 最受欢迎的应用 atom:GitHub推出的编辑器. GitHub:https://github.com/atom/atom Jekyll:一个强大的静态Blo