zoukankan      html  css  js  c++  java
  • MarkDown编写规范指南

    Markdown 编写规范指南

    简介:

    Markdown的目标是实现「易读易写」,成为一种适用于网络的「书写语言」。
    一份使用Markdown格式撰写的文件可以直接以纯文本发布,它的最大灵感来源其实是纯文本电子邮件的格式。

    Markdown的语法由一些符号所组成,其作用一目了然。
    比如:在文字两旁加上星号,看起来就像强调。

    Markdown兼容HTML语法并且会将<和&等符号进行自动转换,这项特性可以让我们很容易地用Markdown写HTML code。

    目录

    基础语法

    标题

    # 这是 <h1> 标签
    ## 这是 <h2> 标签
    ###### 这是 <h6> 标签
    

    强调

    *这里文字是斜体*
    _这里文字也是斜体_
    
    **这里文字是粗体**
    __这里文字也是粗体__
    
    _你也 **可以** 这样组合他们_
    

    实际效果:

    这里文字是斜体
    这里文字也是斜体

    这里文字是粗体
    这里文字也是粗体

    你也 可以 这样组合他们

    列表

    无序列表

    + 条目 1
    + 条目 2
      + 条目 2a
      + 条目 2b
    

    实际效果:

    • 条目 1
    • 条目 2
      • 条目 2a
      • 条目 2b

    有序列表

    1. 条目 1
    2. 条目 2
    3. 条目 3
      + 条目 3a
      + 条目 3b
    

    实际效果:

    1. 条目 1
    2. 条目 2
    3. 条目 3
    • 条目 3a
    • 条目 3b

    图像

    ![Logo](/image/logo.png)
    

    链接1

    [BaiDu](http://www.baidu.com)
    

    链接2

    我用上面那种方式进行连接,发现点击的时候是在当前页面打开的,所有就又整理了下可以新窗口打开的方法:
    效果:点击打开百度首页
    方法是:<a href="https://www.baidu.com/" target="_blank">点击打开百度首页</a>

    引用

    就像邵林说的:
    
    > 我们活在未来
    > 现在只是我们的过去
    

    实际效果:

    就像邵林说的:

    我们活在未来
    现在只是我们的过去

    内敛代码

    我想你可以在这里
    使用 `<addr>` 元素
    

    实际效果:

    我想你可以在这里
    使用 <addr> 元素

    Github 风味的 Markdown

    Github 定义了一些额外的语法,让文档编写变得更加简单和优雅,也是我们推荐使用的

    语法高亮

    在文章中嵌入不同语言的代码,并自动高亮关键字和语法错误

    ```javascript
    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div: '#foo'})
      }
    }
    \`\`\`
    

    实际效果:

    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div: '#foo'})
      }
    }
    

    任务列表

    + [x] 这是已完成的项目
    + [ ] 这是未完成的项目
    

    实际效果:

    • [x] 这是已完成的项目
    • [ ] 这是未完成的项目

    删除线

    ~~删除了的项目~~
    

    实际效果:

    删除了的项目

    表格

    每一列通过管道符 | 分割,表头通过 - 标记即可

    第一个表头 | 第二个表头
    ---------- | ---------
    第一行第一个 | 第一行第二个
    第二行第一个元素 | 第二行第二个
    

    实际效果:

    第一个表头 第二个表头
    第一行第一个 第一行第二个
    第二行第一个元素 第二行第二个

    超链接

    请为 Git 提交的 SHA-1 hash 值,issue #编号 设置超链接

    作者:有梦想的乌龟·
  • 相关阅读:
    DB-概念-同义词:同义词/Synonym
    DB-概念-数据库:数据库/Database
    DB:目录
    信息安全-OAuth2.0:NuGetFromMicrosoft
    资源-DotNet-站点:DotNet 站点列表
    Nuget-Swagger-Swashbuckle:Swashbuckle
    Nuget-Doc:Nuget 简介
    Nuget-Doc:NuGet 介绍
    术语-Portal:Portal(Web站点)
    cocos2d-html5模板分析
  • 原文地址:https://www.cnblogs.com/nlbnick/p/6119764.html
Copyright © 2011-2022 走看看