← Go back

MarkDown语法一

MarkDown快速入门

Table of contents

Open Table of contents

    Markdown 是一种轻量级标记语言,创始人为約翰·格魯伯(John Gruber)。 它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”

    标题

    MarkDown支持6级标题,在行首插入1到6个#,并在#后加一个空格,对应1到6级标题

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题
    

    显示效果:

    一级标题

    二级标题

    三级标题

    四级标题

    五级标题
    六级标题

    修饰符号

    **加粗**
    __加粗__
    *斜体*
    _斜体_
    

    显示效果:

    加粗

    加粗

    斜体

    斜体

    删除线

    删除线是 GFM 扩展语法:

    ~~这是删除线~~
    

    显示效果:

    这是删除线

    列表

    无序列表

    无序列表可以使用 *、+ 或 - 作为子项标记;子列表需要缩进。

    * Google
    + Alibaba
      + Taobao
      * Tmall
      - 支付宝
    - Apple
    

    显示效果:

    • Google
    • Alibaba
      • Taobao
      • Tmall
      • 支付宝
    • Apple
    有序列表

    有序列表使用数字和英文句点,句点后需要一个空格;嵌套列表需要缩进。

    1. 早
       1. 起床
       2. 吃早点
       3. 开始敲代码
    2. 中
    3. 晚
    

    显示效果:

    1. 早
      1. 起床
      2. 吃早点
      3. 开始敲代码
    2. 中
    3. 晚

    链接

    格式为[文本](链接 提示文本) 提示文本可以不要

    点击[这里](http://www.baidu.com "你点下试试呗")打开百度
    

    显示效果:

    点击这里打开百度

    图片

    格式和链接类似,多了一个感叹号

    ![文本](/img/cannondale_twitter.png "头像图片")
    

    显示效果:

    文本

    代码

    行内代码

    行内代码使用一对反引号包住代码。

    `Hello World`
    

    显示效果

    Hello World

    代码段

    代码段可用三个或更多反引号包围;开头可写语言名以供语法高亮。这是 GFM 围栏代码块语法。

    ```java
    class Alee {
        public static void main(String[] args) {
            System.out.println("Hello World");
        }
    }
    ```
    

    显示效果:

    class Alee {
    	public static void main(String[] args) {
    		System.out.println("Hello World");
    	}
    }
    

    表格

    表格是 GFM 扩展语法,不属于原始 Markdown;使用 分隔内容,并可用 - 和 : 指定对齐方式。
    |Header1|Header2|Header3|
    |----|:--:|---:|
    |默认|居中|右|
    

    显示效果:

    Header1 Header2 Header3
    默认 居中 右

    引用

    使用 > 符号来加入引用。

    > 在很久很久以前,有一个人发明了MarkDown
    

    显示效果:

    在很久很久以前,有一个人发明了MarkDown

    分割线

    使用三个或更多的连字符或星号。加号不是分割线标记。

    ---
    ***
    

    显示效果:



    转义

    在可转义的标点符号前加反斜杠,可以让它按普通字符显示。

    \+++ 
    

    显示效果

    +++

    段落和换行

    在MarkDown中段落由一行或者多行文本组成,相邻的两行文字会被视为同一段落,如果存在空行则被视为不同段落,MarkDown支持段内换行,如果想在段落内换行则输入两个或以上空格然后再回车

    第一段落第一行  
    第一段落第二行
    
    第二段落
    

    显示效果:

    第一段落第一行
    第一段落第二行

    第二段落

    HTML标签

    本项目的 Kramdown GFM 支持常见的原始 HTML 标签,需要时可以直接使用。

    <p>Alee</p>
    

    显示效果:

    Alee

    文本高亮

    ==文字== 不是本项目 Kramdown GFM 识别的语法,会原样显示。需要高亮时可以使用 HTML 的 <mark> 标签。

    <mark>这里</mark>
    

    显示效果:

    这里

    复选框

    任务列表是 GFM 扩展语法,必须写在列表项中;本项目会将它们渲染为不可交互的复选框。

    - [x] 已勾选
    - [ ] 未勾选
    

    显示效果:

    • 已勾选
    • 未勾选

    脚注

    脚注是 Kramdown 扩展语法,原始 Markdown 和 GFM 标准均未定义此语法:

    正文[^note]正文
    [^note]: 脚注内容
    

    看示例:

    这里是Alee[^1]的博客。
    
    [^1]: Alee是一枚Android程序员
    

    显示效果:

    这里是Alee1的博客。

    说明

    相同 ID 的引用会指向同一条脚注;不同脚注请使用不同 ID。

    规则
    1. 未被引用的脚注定义会被忽略。
    2. 没有对应定义的引用会保留为普通文本,不会自动生成脚注。
    3. ID 可使用字母、数字、下划线和连字符,不能包含空格。
    1. Alee是一枚Android程序员 ↩