如何写一个优秀的GitHub项目README文档？
今天给大家介绍一个Github上的README文档写作教程模版，该模版目前获得6634颗星星，2296Fork，相对而言，还是比较得到大家认可的。不花哨，不别出心裁，一个比较实用的，普适性的架子；所谓教科书式，不外如此。原文是英语，大神可直接看戳我查看。下面是我翻译的中文版（未完全按照原文翻译 ...
原文：【github】论怎么去写一个高大上的ReadMe
前言 以前我时常觉得，自己写的ReadMe很单调乏味，但后来仔细研究一下后，发现有很多方式可以让ReadMe在简洁的基础上变得好看些，所以在这里和大家分享，如果大家有更好的想法，也非常欢迎在评论区留言哦 美化方案 加彩色徽章：介绍npm版本，证书类型，发布版本等 给代码添加颜色，不要使用纯文本啦 给自己的代码库设计一个专属的logo 有想到再加其他的 最终结果 Github地址 https: gi ...
2019-09-09 08:02 9 942 推荐指数：
相关推荐
如何写一个通用的README规范
背景 我们平常在进行项目开发时，一般都会把代码上传至代码托管平台上方便管理和维护。目前我厂使用的托管平台是SVN，国内外还有一些比较知名的代码托管平台，比如github、Gitlab、BitBucket，码云和码市等。 但我们在多人合作开发下，经常碰到的最头疼的问题是，其他开发者 ...
GitToc-为你的Github仓库的Readme自动生成一个目录
维护自己的Github仓库的时候发现Github的Readme不支持Toc目录，所以就自己写了一个小工具。 工具地址：https://github.com/Holy-Shine/GitToc 简介 如下是转换效果： 转换后的目录支持页内跳转 使用教程 假设你的目标文件名 ...
Github 个人首页的 README，这样玩儿~
本文首发于 Ficow Shen's Blog，原文地址： Github 个人首页的 README，这样玩儿~。 内容概览 前言 创建仓库 修改 README 的内容 总结 前言 大家最近有没有发现这个现象，有些名人的 Github 首页变得 ...
GITHUB readme基本语法
而不让其转化为大标题，则需要在两者之间加一个空行。 另一种方法：（推荐这种方法；注意中间需要有一个 ...
github上ReadMe语法
大标题 =================================== 大标题一般显示工程名,类似html的\<h1\>< ...
如何在Github上用Markdown写好ReadMe
MarkDown的基本语法（可以直接复制下述内容到github的readme.md显示结果） 一、标题写法：第一种方法：1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标 ...
关于github里readme编辑的方法
实验室的老师昨天改完论文发我后，说按照例子改。于是才发现github里readme编辑满满的极客思维。 看了一下csdn给的教程 https://blog.csdn.net/Kaitiren/article/details/38513715 连圆点都用转义字符星号控制了:本地化自有化的思维 ...