前言

以前我时常觉得,自己写的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
可以给自己设计图标,名称和介绍,这下面是我的使用过程
 
 
效果如下
 
哦,对了,我前端时间开始和爸妈学做菜了,那就写个做菜的技术总结吧

做菜的技术总结

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

【github】论怎么去写一个高大上的ReadMe的更多相关文章

  1. 用node.js从零开始去写一个简单的爬虫

    如果你不会Python语言,正好又是一个node.js小白,看完这篇文章之后,一定会觉得受益匪浅,感受到自己又新get到了一门技能,如何用node.js从零开始去写一个简单的爬虫,十分钟时间就能搞定, ...

  2. 用android去写一个小程序

    前言: 软工的一个小作业:实现"黄金分割小游戏", 需要结对编程,队友:陈乐云    共用时两天. 早期思路设计: 采用键值对的形式,以Map作为存储结构.优点:能够将数据与用户对 ...

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

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

  4. 操刀 requirejs,自己动手写一个

    前沿 写在文章的最前面 这篇文章讲的是,我怎么去写一个 requirejs . 去 github 上fork一下,顺便star~ requirejs,众所周知,是一个非常出名的js模块化工具,可以让你 ...

  5. 使用原生node写一个聊天室

    在学习node的时候都会练习做一个聊天室的项目,主要使用socket.io模块和http模块.这里我们使用更加原始的方式去写一个在命令行聊天的聊天室. http模块,socket.io都是高度封装之后 ...

  6. 是否有必要学习使用纯Verilog写一个SDRAM控制器

    在做这个SDRAM控制器之前,博主有一个疑问,对于学生来说,是否有必要学习用纯Verilog写一个SDRAM控制器?因为目前X家和A家都有了DDR IP Core,对于要实现一个应用可以直接调用IP ...

  7. 手写一个简单的starter组件

    spring-boot中有很多第三方包,都封装成starter组件,在maven中引用后,启动springBoot项目时会自动装配到spring ioc容器中. 思考: 为什么我们springBoot ...

  8. 写一个程序,统计自己C语言共写了多少行代码,Github基本操作

    前言 在上一篇博客中,本人提到了自己的文件操作可以说是几乎没用过.现在想想,这也算是只在OJ上做题的一个弊端吧.虽然通过OJ做题是一个学习代码好手段,但其他方面也要多多涉猎才好,而不是说OJ用不到文件 ...

  9. 我去,徒弟半夜来电让写一个PHP短信验证(和群发)

    感觉很纳闷啊,,..好几天几乎通宵了,今晚本来以为有个早觉睡,居然2点多才打电话来让帮忙... 记得前段时间还有博友问过同类的问题.... 名字我就隐藏掉了,呵呵,, 我在网上随便找了一个提供相应接口 ...

随机推荐

  1. Django是如何防止注入攻击-XSS攻击-CSRF攻击

    注入攻击-XSS攻击-CSRF攻击介绍请访问:https://www.cnblogs.com/hwnzy/p/11219475.html Django防止注入攻击 Django提供一个抽象的模型层来组 ...

  2. centos7安装mongodb详解

    记录一下linux下安装mongodb数据库过程. 安装mongodb #下载linux版本的tar文件#  例如笔者下载的是:mongodb-linux-x86_64-rhel70-3.4.4.tg ...

  3. Unity经典游戏教程之:贪吃蛇

    版权声明: 本文原创发布于博客园"优梦创客"的博客空间(网址:http://www.cnblogs.com/raymondking123/)以及微信公众号"优梦创客&qu ...

  4. 5.Go-封装、继承、接口、多态和断言

    面向对象 Go语言开发者认为:面向对象就是特定类型(结构体)有着自己的方法,利用这个方法完成面向对象编程, 并没有提封装.继承.多态.所以Go语言进行面向对象编程时,重点在于灵活使用方法. Go语言有 ...

  5. 【0806 | Day 9】异常处理/基本的文件操作

    一.异常处理 异常即报错,可分为语法异常和逻辑异常 1. 语法异常 举个栗子 if #报错 syntaxerror 0 = 1 #报错 syntaxerror ... 正经地举个栗子 print(1) ...

  6. java swing 开发 -JTable

    最近利用空闲时间自己琢磨了一下java swing 编程,其实在从事javaweb之前我一直向往的就是java swing 开发,不知道为什么可能当时觉得Windows上的exe程序很是神奇,关于wi ...

  7. H5 Handlebars的简单使用

    扫码关注公众号,不定期更新干活 web 开发中,js 解析JSON 是经常的事情.非常繁琐.handlebars 使用了模版,只要你定义一个模版,提供一个json对象,handlebars 就能吧js ...

  8. Json串与实体的相互转换 (不依赖于jar包 只需Eclipse环境即可)

    Json串与实体的相互转换 (不依赖于jar包 只需Eclipse环境即可) 最近学习了javaWeb开发,用的是ssh框架里面自己整合了hibernate 和Struts2 和spring框架,其中 ...

  9. UVA - 1152 --- 4 Values whose Sum is 0(二分)

    问题分析 首先枚举a和b, 把所有a+b记录下来放在一个有序数组,然后枚举c和d, 在有序数组中查一查-c-d共有多少个.注意这里不可以直接用二分算法的那个模板,因为那个模板只能查找是否有某个数,一旦 ...

  10. springboot集成redis实现消息发布订阅模式-双通道(跨多服务器)

    基础配置参考https://blog.csdn.net/llll234/article/details/80966952 查看了基础配置那么会遇到一下几个问题: 1.实际应用中可能会订阅多个通道,而一 ...