码迷,mamicode.com
首页 > 其他好文 > 详细

Markdown编辑器语法指南

时间:2015-03-14 23:13:29      阅读:139      评论:0      收藏:0      [点我收藏+]

标签:markdown   syntax   编辑器   guide   指南   

E文好的同学请查看英文原文: Markdown syntax guide

目录


您可以使用[TOC]在文章的任何位置插入目录,甚至插入多个目录。

呈现效果:


标题


# 这是一级标题,相当于HTML中的H1标签
## This is an H2
###### This is an H6

呈现效果:


这是一级标题,相当于HTML中的H1标签

This is an H2

This is an H6

段落


每个段落从一个新行开始,段落前最好有一个空行。只需按下回车键<Enter>开始一个新行。

例如,
像下面这样。

你需要在段落和任何以下的内容之间保留一个空行
如有序或无序的列表,像下面这样:

* 项目 1 
* 项目 2

呈现效果:


每个段落从一个新行开始,段落前最好有一个空行。只需按下回车键<Enter>开始一个新行。

例如,
像下面这样。

你需要在段落和任何以下的内容之间保留一个空行
如有序或无序的列表,像下面这样:

  • 项目 1
  • 项目 2

字符样式


*&nbsp;&nbsp;斜体字符*
**粗体字符**
~~删除线的文字~~

注意:*号与内容之间不要有空格,如果确实需要使用空格,请使用&nbsp;

呈现效果:


  斜体字符
粗体字符
删除线的文字

无序的列表


* Item 1
* Item 2
* Item 3
    * Item 3a
    * Item 3b
    * Item 3c

注意:*号与内容之间需要有空格

呈现效果:


  • Item 1
  • Item 2
  • Item 3
    • Item 3a
    • Item 3b
    • Item 3c

排序的列表


1. Step 1
2. Step 2
3. Step 3
    a. Step 3a
    b. Step 3b
    c. Step 3c

注意:.号与内容之间需要有空格

呈现效果:


  1. Step 1
  2. Step 2
  3. Step 3
    a. Step 3a
    b. Step 3b
    c. Step 3c

在列表中的列表


1. Step 1
2. Step 2
3. Step 3
    * Item 3a
    * Item 3b
    * Item 3c

呈现效果:


  1. Step 1
  2. Step 2
  3. Step 3
    • Item 3a
    • Item 3b
    • Item 3c

引号或引文


这是一段引用的内容

>引用的内容
>引用的内容
>引用的内容

呈现效果:


这是一段引用的内容

引用的内容
引用的内容
引用的内容

内联代码字符


使用反撇号 `function()` 是指。

这里有一个字符 `` 引号 (`)``

呈现效果:


使用反撇号 function() 是指。

这里有一个字符 引号 (`)

行内代码及代码块


缩进每一行由至少 4 个空格或 1 个制表符Tab。

这是一个正常的段落:

    这是一个代码块。
    包含多行。

或者,您可以使用 3 个反引号在代码块之前和之后,像这样:

 ```
这是一个代码块
 ```

若要使添加的代码块高亮,将代码语言的名称添加到紧随反引号之后:

 ```javascript
var oldUnload = window.onbeforeunload;
window.onbeforeunload = function() {
    saveCoverage();
    if (oldUnload) {
        return oldUnload.apply(this, arguments);
    }
};
 ```        

注意:在代码块中插入代码块的Markdown格式时,需要在反引号之前添加空格,否则呈现的布局会超出你的预期。

支持所有常见的编码语言,包括 C、 c++、 Java、 Scala,Python 和 JavaScript。

呈现效果:


缩进每一行由至少 4 个空格或 1 个制表符Tab。

这是一个正常的段落:

这是一个代码块。
包含多行。

或者,您可以使用 3 个反引号在代码块之前和之后,像这样:

这是一个代码块

若要使添加的代码块高亮,将代码语言的名称添加到紧随反引号之后:

var oldUnload = window.onbeforeunload;
window.onbeforeunload = function() {
    saveCoverage();
    if (oldUnload) {
        return oldUnload.apply(this, arguments);
    }
};

外部网站链接


这是 [一个例子](http://blog.csdn.net/column/details/markdown.html "标题") 的内联链接。

[这个链接](http://blog.csdn.net/testcs_dn) 没有标题属性。

注意:括号必需要是英文半角的。

呈现效果:


这是 一个例子 的内联链接。

这个链接 没有标题属性。

图像


图像及图像链接语法如下所示:

![我的头像](http://avatar.csdn.net/D/1/B/1_testcs_dn.jpg)
![专家图标](http://c.csdnimg.cn/jifen/images/xunzhang/xunzhang/bokezhuanjiamiddle.png "专家图标")
[![专栏图标](http://avatar.csdn.net/blogpic/20150309232245583.jpg)](http://blog.csdn.net/column/details/markdown.html "CSDN-Markdown专栏")

呈现效果:


技术分享
技术分享
技术分享

表格


|每天 |主食 |价格 |
|--------|---------|-------|
|周一 |面食 |$6 |
|周二 |鸡 |$8 |

呈现效果:


每天 主食 价格
周一 面食 $6
周二 $8

反斜杠转义符


Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 <em> 标签),你可以在星号的前面加上反斜杠:

\* 字符星号 \*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

这里再插入一个目录:

Markdown编辑器语法指南

标签:markdown   syntax   编辑器   guide   指南   

原文地址:http://blog.csdn.net/testcs_dn/article/details/44264609

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!