我們在寫一個開源項目的時候 往往需要寫一下readme來讓別人簡要的瞭解一下項目的運行環境、以及採用的思路,那麼如何寫一個好的readme呢 github有自己的符號來進行標題、正文、分行、代碼片段等的實現,以下幾個是常用的符號:
一、## (注意:#越多字號越小)
這個符號是用來生成加粗標題字體的 同時會生成一條底邊線 比如:## 技術棧:
二、1.``` 英文 ```
這個符號是用來顯示英文 會生成一個帶有淺灰色的背景 比如:
2.```javascript(注意這個javascript是必須要的,不然不會識別是代碼)
js代碼
```
三、>
這個符號是用來生成豎向分割線的 比如:
四、[]()
這是一個組合符號 其中[] 裏放的是內容 ()放的是url 作用就相當於a標籤
比如:[地址在這裏](https://github.com/bailicangdu/vue2-elm)
五、![]()
這也是組合符號 作用是用來顯示圖片的 其中()放的是圖片的src地址
比如:![](https://github.com/demo.png)
六、** 內容 **
這個符號是用來表示文章內的副標題 、小標題等加粗字體
比如:
**組件在初始化時會觸發5個鉤子函數:**
**1、getDefaultProps()**
> 設置默認的props,也可以用dufaultProps設置組件的默認屬性。
七、- [x]
這個符號的效果是生成 √
好了 常用的符號基本就是這幾個了,希望對大家有所幫助!