How to Write a README on GitHub】的更多相关文章

最近在寫 GitHub 上的 README,發現這個東西好像每個人的寫法都不太一樣,於是稍微整理了一下自己覺得大概要包含哪些內容. Motivation 顧名思義就是簡介一下為什麼會有這個專案,以及這個專案大概在做什麼,解決了什麼問題.最好是三到五句話講出重點,不然很多人看到落落長的文章可能就跳過了 XD Getting Started / Installation 如何快速地開始使用這個專案,通常會包含安裝以及環境設定等等. Example / Demo 一個簡單有力的範例可以讓大家更容易了解…
一.远程仓库怎么玩 1. 自己搭建一个运行Git的服务器 Git是分布式版本控制系统,同一个Git仓库,可以分布到不同的机器上,但肯定有一台机器有着最原始的版本库,然后别的机器来克隆这个原始版本库,这样子就没有主次之分!因此,很多时候,我们会找一台电脑来充当服务器的角色,每天24小时开机,便于其他人从这个“服务器”仓库克隆到自己的电脑上,并且各自把各自的提交推送到服务器仓库,也从服务器仓库中拉取别人的提交. 2. 注册GitHub免费获得Git远程仓库 "GitHub是一群有趣的人在做的有趣的事…
摘要:这是一篇很详尽的独立博客搭建教程,里面介绍了域名注册.DNS设置.github和Hexo设置等过程,这是我写得最长的一篇教程.我想将我搭建独立博客的过程在一篇文章中尽可能详细地写出来,希望能给后来者一个明确的指引,同时用这篇教程开篇,正式开始我的第八大洲之旅. 前言 作为一个技术小白,没有技术基础,看网上的教程也云里雾里,看程序员的教程相当不容易,稍微有些细节描述得不清楚自己就要绕弯路去找答案(善用搜索引擎),所以,在自己的博客搭建完成之后,我决定要将我搭建博客的过程全记录下来,以供后期和…
<config> PyCharm与GitHub配置使用总结 <readme> 在github的readme添加图片 github readme写法 GitHub上README.md写法总结 <bug> bug 1:push of current branch was rejected remote changes need to be merged before pushing ref 出错原因: 是因为远程repository和我本地的repository冲突导致的,…
GitHub 风格的 Markdown 语法 [译] GitHub 风格的 Markdown 语法 Original: GitHub Flavored Markdown - GitHub Help Translated by: cssmagic 声明:原文版权属于 GitHub.中文翻译部分并非官方文档,仅供参考. GitHub uses what we're calling "GitHub Flavored Markdown" (GFM) for messages, issues,…
最新博客链接 Github链接 查看此文档前应先了解,vuepress基本操作 参考官方文档进行配置: vuepress-theme-reco VuePress SamKirkland / FTP-Deploy-Action 最终效果 最终效果链接 思路 下载vuepress-theme-reco官方的主题模板(脚手架),再根据自己的需要进行相应的修改,再根据自己的服务器配置Github Actions文件,最后上传到Github,触发Github Actions自动构建部署到第三方服务器.以后…
一,准备环境 1,提前安装git环境和GitHub做集成,不做多解释: 1,准备微信项目代码: 2,创建GitHub仓库: 二,创建GitHub仓库 1,创建一个空的GitHub仓库,不要任何文件和不要创建任何分支,后面会从微信开发工具统一导入.(只用填个name,其他不勾选,勾选了会自己创建master分支,这里不用创建分支,如果还是勾选了,后面会讲怎么把微信本地版本分支合并到这个分支上面) 2,创建完成后复制项目地址,后面有用 三,微信版本工具集成GitHub 1,打开微信开发工具,导入本地…
这段时间大家在家自我隔离.居家办公憋坏了吧.为了打发这种无聊的生活,我决定拿出我在github上珍藏多年的沙雕项目,让大家在无聊的时候可以打发时间. Github作为互联网上最大的开源社区,一直备受程序员的喜爱,里面不仅有许多优秀的开源项目,还有很多让人看了打破常人三观的的沙雕项目,下面我就来分享下. 91某先生Logo 一个在线的 PorHub 风格 Logo 生成工具 Logoly.Pro ,可以帮助你快速生成类似 PorHub 风格的 Logo,感觉好骚. 在线体验 网站:https://…
jQuery2.x源码解析(构建篇) jQuery2.x源码解析(设计篇) jQuery2.x源码解析(回调篇) jQuery2.x源码解析(缓存篇) 笔者阅读了园友艾伦 Aaron的系列博客<jQuery源码分析系列>,跑艾伦的部分代码后,感觉仍然不够解渴,对jQuery依旧一知半解,产生了很多问题.阅读源码博客已经无法解决这些问题,所以笔者决定亲自查看jQuery源码,解除心中的疑问.阅读的形式属于自问自答,笔者会提出疑问,然后亲自解答(吐槽:感觉有点像一休哥和将军大人>_<)…
在开发环境下,往往需要一个工具来自动重启项目工程,之前接触过 python 的 supervisor,现在写 node 的时候发现 supervisior 在很多地方都有他的身影,node 也有一个 npm 模块 supervisior 也是用来监控进程的,不过除了 supervisior 外,还有很多其他的工具,从 github 的评分上看,比较热门的有 forever,nodemon,node-dev,具体这些工具的区别可以参考这篇文章  Comparison: Tools to Autom…