如何写一个优秀的GitHub项目README文档？

【如何写一个优秀的GitHub项目README文档？】的更多相关文章

如何写一个优秀的GitHub项目README文档？

今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓教科书式,不外如此.原文是英语,大神可直接看戳我查看.下面是我翻译的中文版(未完全按照原文翻译),献丑了. 项目名称这里再写一句骚气又精准的话描述你的项目吧. 上手指南写几句这样的话概括接下来的内容:以下指南将帮助你在本地机器上安装和运行该项目,进行开发和测试.关于如何将该项目部署到在线环境,请…

为Github项目创建文档

有两种编写方式: In reStructuredText In Markdown In reStructuredText 工具: pip install sphinx sphinx-autobuild 克隆你的仓库到本地: git clone https://github.com/yourusername/yourrepository.git 在仓库根目录内创建文档: mkdir docs & cd docs sphinx-quickstart //按照提示一路下去,会生成index.rs…

优秀的github项目学习

优秀的github项目学习后期会陆续添加遇到的优秀项目 https://github.com/chaijunkun…

喜大普奔！GitHub中文版帮助文档上线了！

日前,GitHub 文档的简体中文正式发布,开发者可以到官方文档上随意查阅浏览中文文档啦! 对于想要玩 GitHub,但一直苦于英语水平较差的程序员来说,这真是一个天大的好消息.下面一起来感受一下中文文档吧是不是瞬间觉得 GitHub 变的十分接地气了呢,而且无论你是初级入门,还是中高级选手都适用哦~ 其中,GitHub 企业版帮助文档也上线了,用户可根据具体需求点击"管理员指南"或"用户指南"来查看详细内容. 企业版涵盖管理员指南和用户指南:…

手把手教你搭建一个跟vue官方同款文档（vuepress）

前言 VuePress 由两部分组成:第一部分是一个极简静态网站生成器 (opens new window),它包含由 Vue 驱动的主题系统和插件 API,另一个部分是为书写技术文档而优化的默认主题,它的诞生初衷是为了支持 Vue 及其子项目的文档需求. 概要基础命令基础配置总结基础命令(粘贴复制就行了,我也是复制过来的) mkdir vuepress-starter && cd vuepress-starter yarn init # npm init yarn add -D…

kettle开源项目部署文档

kettle开源项目部署文档 1.kettle简介 kettle是一款国外开源的ETL(Extract Transform Load)工具,纯java编写,可以在Windows.Linux.Unix上运行,绿色无需安装,被设计用来抽取.转换.装入和加载数据,可以行象的理解为将各种数据放入到一个壶里面后以一种指定的格式流出来. kettle中有两种脚本文件,transformation(.ktr)和job(.kjb),transformation完成针对数据的基础转换,job则完成整个工作流程的控…