zoukankan      html  css  js  c++  java
  • github中README.md书写规范

    README.md语法规则

    一、换行

    段落1<br>段落2
    
    段落3

    段落1
    段落2

    段落3

    二、标题

    Setext形式:= 大标题 - 中标题
    atx形式:#

    大标题
    ======
    中标题
    ------
    #一级标题  
    ##二级标题  
    ###三级标题  
    ####四级标题  
    #####五级标题  
    ######六级标题 

    大标题

    中标题

    一级标题

    二级标题

    三级标题

    四级标题

    五级标题
    六级标题

    三、区块

    >区块1
    >>区块2
    >>>区块3

    区块1

    区块2

    区块3

    四、强调(有问题)

    *强调* 或者 _强调_ (示例:斜体)
    **加重强调** 或者 __加重强调__ (示例:粗体)
    ***特别强调*** 或者 ___特别强调___ (示例:粗斜体)

    *强调*<br>
    _强调_<br>
    **强调**<br>
    __强调__<br>
    ***强调***<br>
    ___强调___<br>

    强调
    强调
    强调
    强调
    强调
    强调

    五、列表

    注意:* + - 前后加空格,tab键或四个空格可分级)

    * 列表1
     + 列表2
       - 列表3
    • 列表1
      • 列表2
        • 列表3

    六、链接

    [百度一下-你就知道](http://www.baidu.com "百度一下")

    百度一下-你就知道

    七、图片:[]( "title")

    ![百度](baidu.png "百度图片")

     

    八、代码 :$ <> 会被自动的转换成 HTML 实体

    `
    代码代码代码
    代码代码代码
    `

     代码代码代码 代码代码代码  

    ```
     代码代码代码
     代码代码代码
     ```
    代码代码代码
    代码代码代码
    

    要建立一个已经格式化好的代码区块,只要每行都缩进 4 个空格或是一个 tab 就可以了。

    最后,注意反斜杠实现转义效果。

  • 相关阅读:
    Fusion access
    组网架构
    DHCP中继
    Vxlan配置
    redis多实例
    ansible实现redis角色
    ansible如何ssh免密链接(基于key验证)
    MySQL主从复制
    MySQL范例
    Ubuntu2004安装
  • 原文地址:https://www.cnblogs.com/guchunli/p/6371040.html
Copyright © 2011-2022 走看看