如何写github的README.md

我们在写一个开源项目的时候 往往需要写一下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]

  这个符号的效果是生成 √

好了  常用的符号基本就是这几个了,希望对大家有所帮助!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值