前言

以前我时常觉得,自己写的ReadMe很单调乏味,但后来仔细研究一下后,发现有很多方式可以让ReadMe在简洁的基础上变得好看些,所以在这里和大家分享,如果大家有更好的想法,也非常欢迎在评论区留言哦

美化方案

  • 加彩色徽章:介绍npm版本,证书类型,发布版本等
  • 给代码添加颜色,不要使用纯文本啦!
  • 给自己的代码库设计一个专属的logo
  • 有想到再加其他的

最终结果

Github地址

https://github.com/penghuwan/water.js​github.com

Act1. 加彩色徽章

大家可能会感到奇怪,下面这些彩色徽章哪里来的呢?
其实它们都来自这一个网站:https://shields.io/
打开网站,往下翻,可以看到几个输入框,如下所示
比如我们想要生成license MIT这样的徽章,就分别在label和message上填写,同时选择颜色,最后点击Make Badge
点击Make Badge后会跳转到一个打开的图标文件,这个地址就是图片的引用地址
然后我们只要把这个地址复制到ReadMe上写成图片就好了,比如
![](https://img.shields.io/badge/license-MIT-blue)

看到的结果
 

Act2. 加代码颜色

我们知道,我们可以用下面的Markdown标记添加代码块
``` 代码 ```

但如果仅仅这样,代码是没有颜色的,就像这样
如果我想加上颜色,我可以这么做: 给```后面加上语言名简写,比如:js
```js 代码 ```

然后代码就被赋予颜色了呀(灵魂)
同理,python的代码颜色可以这样设置
```python #!/usr/bin/python3 print("Hello, World!"); ```

其他语言也是一样的,大家自己替换上去就好了

Act3. 给自己的代码库设计一个logo

设计logo的网站很多,一查就有,随便你用哪个,但是我用过的设计最好,体验最好的还是下面这个Canva
https://www.canva.cn/design/DADk291IBFw/xK_s33mJsndiCPk03TYleQ/edit
可以给自己设计图标,名称和介绍,这下面是我的使用过程
效果如下
哦,对了,我前端时间开始和爸妈学做菜了,那就写个做菜的技术总结吧

做菜的技术总结

  1. 一般常见青菜的做法: 先加油滚热,蒜头拍碎,浸油爆香。然后再放青菜翻炒。酱油在出锅前几分钟再加入。翻炒均匀后出锅。
  2. 油麦菜香麦菜等“软菜”是不需要加水的。但是一些“硬菜”比如青椒之类还是要加点水,不然容易焦糊
  3. 炒鱼的时候,一般煎过比较香,但是我们一般不舍得加没过鱼肉的宽油,所以可以用另一种方法: 加部分油,同时适时转动锅的角度,均匀得煎炸。最后把鱼煎香后放微波炉里烤好
  4. 大白菜的处理是非常典型的,因为大白菜的茎和叶质地差别比较大,茎熟的慢,叶子熟的很快,所以建议手动剥开两份,先炒白菜茎,再炒白菜叶
  5. 木耳炒肉的时候,判断出锅时机是水煮浅,木耳发出噼里啪啦的声音
  6. 肉卷切片越薄越好,而且刀工要利索,炒肉丸的时候如果不处理肉丸会不够入味,需要每个丸子都用菜刀划几刀,成井字形
  7. 秋葵好像不能切段的时候好像不能切太碎,否则籽会都掉出来
  8. 鱼和鸭子要加生姜炒,压腥味,可以考虑加点料酒,鸭子最好高压蒸熟,单单炒的话炒不透的,咬起来很硬。
  9. 当处理西红柿炒鸡蛋时候,肯定是先把鸡蛋炒好成型,然后加西红柿的,不然的话西红柿和鸡蛋同时放会 。。。。emmmm
  10. 常见的一种蘸酱调料的制作方式: 蒜瓣捣碎成蒜蓉,混入金谷饭,醋和香菜,用来沾者油炸豆腐吃,感觉还可以呀
  11. 老抽和生抽作用是不一样的,生抽增味,老抽着色
本文完

转载于:https://www.cnblogs.com/penghuwan/p/11485101.html

【github】论怎么去写一个高大上的ReadMe相关推荐

  1. Markdown 工程师也不简单:如何写一个高逼格 README

    最近一个项目从程序员变成了一个高级文档哥,好吧,我还称不上高级,但是我发现写文档真不是一件容易的事情,要怎么写的让人看的舒服.巴适.爽的不行,看完就想给你个赞呢?我也总结了一下写文档的一些感想,也不能 ...

  2. 如何写一个高逼格 README

    最近一个项目从程序员变成了一个高级文档哥,好吧,我还称不上高级,但是我发现写文档真不是一件容易的事情,要怎么写的让人看的舒服.巴适.爽的不行,看完就想给你个赞呢?我也总结了一下写文档的一些感想,也不能 ...

  3. 如何写一个通用的README规范

    背景 我们平常在进行项目开发时,一般都会把代码上传至代码托管平台上方便管理和维护.目前大家使用的托管平台最多的还是Github,国内外还有一些比较知名的代码托管平台,比如Gitlab.BitBucke ...

  4. 如何自己去写一个鼠标驱动_为什么要用哈密顿采样器(Hamiltonian Monte Carlo),以及如何自己写一个...

    背景介绍:(了解采样的可以跳过) 1)为什么需要采样: 简单的分布,比如高斯.exponential.gamma等等的样本都可以直接用numpy.random生成,但复杂的分布需要采样器生成.在贝叶斯 ...

  5. python github api_用python写一个GitHub Trending Api

    GitHub 给了开发者相当丰富的 API 接口 https://developer.github.com/v3/,包括认证,搜索,活动等接口,但就是没有提供获取 Trending 的接口.因此,需要 ...

  6. gayhub(github)上不去?一个小tip,比XX上网都快

    github.com改成hub.fastgit.org 就可以了! (原谅我水一篇,但是真的实用)

  7. element ui 排课_vue怎么去写一个学校排课系统

    展开全部 html> body,html{ margin: 20px 50px; } .title2{ color: blueviolet; } .table th,td{ text-align ...

  8. 什么是单元测试,如何去写一个单元测试

    相信单元测试是属于那种没有用过也听过的技术(如果你是大佬,听过也用过,欢迎提出宝贵的意见

  9. 如何写一个通用的README规范 1

    背景 我们平常在进行项目开发时,一般都会把代码上传至代码托管平台上方便管理和维护.目前我厂使用的托管平台是SVN,国内外还有一些比较知名的代码托管平台,比如github.Gitlab.BitBucke ...

  10. 多进程同时写一个文件会怎样?分别用write和fwrite去观察现象

    一.问题还原 在多进程的环境下,父子进程同时去写一个文件,例如父进程每次写入aaaaa,子进程每次写入bbbbb,问题是会不会出现写操作被打断的现象,比如出现aabbbaaabb这样交替的情况? 二. ...

最新文章

  1. Java学习之移动文件(转)
  2. idea使用MybatisCodeHelperPro逆向生成(亲测)
  3. 与众不同 windows phone (40) - 8.0 媒体: 音乐中心的新增功能, 图片中心的新增功能, 后台音乐播放的新增功能...
  4. predefined data types in UI5
  5. MATLAB可以打开gms文件吗,gms文件扩展名,gms文件怎么打开?
  6. strlen函数_四种好用的PHP自定义加密函数(可逆/不可逆)
  7. windows2008R2+IIS部署python Django的web环境
  8. 传统MVP用在项目中是真的方便还是累赘?
  9. Linux 完全卸载重装opencv
  10. sublime text3的一些小技巧记录(配gif图)
  11. 如何使用Syncios Data Recovery直接从 iOS 设备恢复数据?
  12. 37. 两个链表的第一个公共节点(C++版本)
  13. Linux下recv函数的使用细节
  14. 双组百分比堆积柱形图的制作
  15. MAC 下如何更改brew源地址
  16. 【毕设基础教学】OLED屏幕使用详解 - 单片机 物联网
  17. Google App Engine + JDO + Spring MVC,CRUD示例
  18. 计算机机械硬盘系统安装,电脑硬盘安装图解,机械硬盘安装-
  19. 别找了,这个命令让你在字符串和十六进制间自由转换
  20. MySQL-备份恢复

热门文章

  1. Android使用自带的文件管理器选择文件并读取内容
  2. 内存错误分析工具----asan(AddressSanitizer)的介绍和使用
  3. MarkDown 语法大全查询
  4. 网站小服务器地址,小网站需要云服务器地址
  5. 通用技术金工工艺高考必考必看的知识点含攻丝与套丝讲解
  6. AudioRecord的用法
  7. ubuntu18.04桌面美化
  8. 图的邻接(链)表表示法 Graph adjacency list representation
  9. 网页简单轮播图的实现
  10. Matlab syms 矩阵变量,matlab syms.m