【github】论怎么去写一个高大上的ReadMe

前言

以前我时常觉得，自己写的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. 老抽和生抽作用是不一样的，生抽增味，老抽着色

本文完