【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
可以給自己設計圖標,名稱和介紹,這下面是我的使用過程
 
 
效果如下
 
哦,對了,我前端時間開始和爸媽學做菜了,那就寫個做菜的技術總結吧

做菜的技術總結

  1. 一般常見青菜的做法: 先加油滾熱,蒜頭拍碎,浸油爆香。然后再放青菜翻炒。醬油在出鍋前幾分鍾再加入。翻炒均勻后出鍋。
  2. 油麥菜香麥菜等“軟菜”是不需要加水的。但是一些“硬菜”比如青椒之類還是要加點水,不然容易焦糊
  3. 炒魚的時候,一般煎過比較香,但是我們一般不舍得加沒過魚肉的寬油,所以可以用另一種方法: 加部分油,同時適時轉動鍋的角度,均勻得煎炸。最后把魚煎香后放微波爐里烤好
  4. 大白菜的處理是非常典型的,因為大白菜的莖和葉質地差別比較大,莖熟的慢,葉子熟的很快,所以建議手動剝開兩份,先炒白菜莖,再炒白菜葉
  5. 木耳炒肉的時候,判斷出鍋時機是水煮淺,木耳發出噼里啪啦的聲音
  6. 肉卷切片越薄越好,而且刀工要利索,炒肉丸的時候如果不處理肉丸會不夠入味,需要每個丸子都用菜刀划幾刀,成井字形
  7. 秋葵好像不能切段的時候好像不能切太碎,否則籽會都掉出來
  8. 魚和鴨子要加生姜炒,壓腥味,可以考慮加點料酒,鴨子最好高壓蒸熟,單單炒的話炒不透的,咬起來很硬。
  9. 當處理西紅柿炒雞蛋時候,肯定是先把雞蛋炒好成型,然后加西紅柿的,不然的話西紅柿和雞蛋同時放會 。。。。emmmm
  10. 常見的一種蘸醬調料的制作方式: 蒜瓣搗碎成蒜蓉,混入金谷飯,醋和香菜,用來沾者油炸豆腐吃,感覺還可以呀
  11. 老抽和生抽作用是不一樣的,生抽增味,老抽着色
本文完


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM