markdown编辑器

Markdown语法使用指南

2017-07-04  本文已影响162人  WinSolstice

Markdown 语法

以下是 Markdown 的常用语法！在以后的笔记中将持续使用 Markdown 语法进行编译，因此，将此分享给大家。

概述

兼容HTML

注意：在 HTML 区块标签间的 Markdown 格式语法将不会被处理*。

注意：在 HTML 区段标签间的 Markdown 格式语法是有效的.

特殊字符自动转换

在 HTML文件中，有两个字符需要特殊处理：< 和 &。
< 符号用于起始标签， & 符号则用于标记 HTML 实体
如果你只是想要显示这些字符的原型，则需要使用实体字符的形式，像是:

< 和 &。

&字符：

AT &T

key &value

才能放到链接标签的 href 属性里

&

4 < 5

Markdown 将会把它转换为：

4 < 5

不过需要注意的是：code 范围内，不论是行内还是区块，< 和 & 两个符号都一定会被转换成 HTML 实体，这项特性让你可以很容易地用 Markdown 写 HTML code(和 HTML 相对而言 HTML 语法中，你要把所有的 < 和 & 都转换为HTML实体，才能在HTML文件里面写出 HTML code)。

区块元素

段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成，它的前后要有一个以上的空行（空行的定义是显示上看起来像是空的，便会被视为空行。
比方说，若某一行只包含空格和制表符，则该行也会被视为空行。普通段落不该用空格或制表符来缩进。

空格 + 空格 + enter = 换行

标题

 # 这是H1标题  

 ## 这是H2标题  

 ### 这是H3标题  

 #### 这是H4标题  

 ##### 这是H5标题

 ###### 这是H6标题

区块引用 Blockquotes

 > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
 > consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

 > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
  consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

> ## 这是一个标题。
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。

任何像样的文本编辑器都能轻松地建立email型的引用。例如在 BBEdit 中，你可以选取文字后然后从选单中选择增加引用阶层。

列表

Markdown 支持有序列表和无序列表。

很重要的一点是，你在列表标记上使用的数字并不会影响 HTML 输出的顺序，上面的列表数字即使是胡乱排序的， HTML 也会按列表自上而下进行排列

Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,  
viverra nec, fringilla in, laoreet vitae, risus.


Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
     Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
         viverra nec, fringilla in, laoreet vitae, risus.
  1. This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.
  2. Suspendisse id sem consectetuer libero luctus adipiscing.
+ 如果你每行都有缩进，看起来会整洁很多，当然，如果你很懒惰，Markdown 也允许：  

+ 如果要在列表项目内放进引用，那 > 就需要缩进：  

+ 如果要放代码区块的话，该区块就需要缩进两次，也就是 8 个空格或是 2 个制表符：

 当然，项目列表很可能会不小心产生，像是下面这样的写法：
  1. What a great season.
在行首出现数字-句点-空白的情况，避免这样的状况，你可以在句点前面加上反斜杠。

#### 代码区块

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块，通常这些区块我们并不希望它以一般段落文件的方式去排版，而是照原来的样子显示，Markdown 会用 &lt;pre> 和  &lt;code> 标签来把代码区块包起来。
要在 Markdown 中建立代码区块很简单，只要简单地缩进4个空格或是1个制表符就可以，例如，下面的输入：

这是一个普通段落：

这是一个代码区块。

Markdown 会转换成:

<p> 这是一个普通段落：</p>

<pre><code>这是一个代码区块。</pre></code>

这个每行一阶的缩进( 4 个空格或是 1 个制表符)，都会被移除，例如：

Here is an example of AppleScript:

tell application "Foo"
    beep
end tell

会被转换为：

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
beep
end tell
</pre></code>

一个代码区块会一直持续到没有缩进的那一行（或是文件结尾）。

在代码区块里面，&、<、> 会自动转成 HTML 实体，这样的方式让你非常容易使用 Markdown 插入范例用的HTML原始码，只需要复制贴上，再加上缩进就可以了，剩下的Markdown都会帮你处理，例如：

<div class="footer">
© 2004 Foo Corporation
</div>

会被转换为：

<pre><code><div class="footer">
© 2004 Foo Corporation
</div>
</code></pre>

代码区块中，一般的 Markdown 语法不会被转换，像是星号便只是星号，这表示你可以很容易地以 Markdown 语法撰写 Markdown 语法相关的文件。

#### 分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线：

————————————————————————————

> 区段元素

#### 链接
Markdown 支持两种形式的链接语法：**行内式**和**参考式**两种形式。
不管是哪一种，链接文字都是用 \[ 方括号 \] 来标记。 

** 行内式链接 **
+ 行内式的链接是用一个方括号紧跟着一个圆括号标识的：\[链接文字\]\(链接地址)
+ \[\]  是 &lt;a&gt; 标签包含着的链接文字&lt;/a&gt;
+ \(\)  是  &lt;a&gt; 标签 href 指向的链接地址
+ 链接后可跟 title 属性，title 不是必须属性，根据需来设置**

This is an example inline link.

例如：

[Markdown语法](https://github.com/WinSolstice/tools/blob/master/README.md title="WinSolstice的markdown语法总结")

 注释：\[链接文字\](链接地址 title)

Markdown会自动转换为：

<p>
<a href="https://github.com/WinSolstice/tools/blob/master/README.md" title="WinSolstice的markdown语法总结">
Markdown语法</a>
</p>

HTML输出为：  
<p><a href="https://github.com/WinSolstice/tools/blob/master/README.md" title="Title">
Markdown语法</a></p>  
如果你是要链接到同样主机的资源，你可以使用相对路径：
<p>

See my About page for details

</p>
<h4> 参考式链接 </h4>
<li>考式链接是用两个方括号标识的：\[链接文字\]\[用以辨识链接的id\]</li>
<li>然后在文件的任意处，你可以把这个id对应的链接地址定义出来</li>
<li>链接后可跟 title 属性，title 不是必须属性，根据需来设置</li>

This is an example reference-style link.
id: http://example.com/ "Optional Title Here"

例如：

[Maekdown语法][WinSolstice title="WinSolstice的markdown语法总结"]

[链接文字][用以辨识链接的id title]

定义 id ：id对应的链接地址 


Markdown会自动转换为：

<p>
<a href="https://github.com/WinSolstice/tools/blob/master/README.md" title="WinSolstice的markdown语法总结">
Maekdown语法</a>
</p>

+ 定义id对应的链接地址：

HTML输出：  

[Maekdown语法][WinSolstice] 
[WinSolstice]:https://github.com/WinSolstice/tools/blob/master/README.md


<p>*此处是[ ]的兼容问题，正常情况下点击html会产生<a href="https://github.com/WinSolstice/tools/blob/master/README.md" title="WinSolstice的markdown语法总结">
Markdown语法</a>的效果*</p>

**链接内容定义的形式为:**

- 方括号（前面可以选择性地加上至多三个空格来缩进），里面输入链接文字，
- 接着一个冒号，
- 接着一个以上的空格或制表符，
- 接着链接的网址，
- 选择性地接着 title 内容，可以用单引号、双引号或是括弧包着,或者将title 属性放到下一行，也可以加一些缩进，若网址太长的话，这样会比较好看： 
+ 链接网址也可以用尖括号包起来：
+ 链接辨别标签可以有字母、数字、空白和标点符号，但是并不区分大小写，因此下面两个链接是一样的：  
下面这三种链接的定义都是相同：

[foo]: http://example.com/ Optional "Title Here"
[foo]: http://example.com/ Optional 'Title Here'
[foo]: http://example.com/ (Optional Title Here)
id: http://example.com/ "Optional Title Here"

*请注意：有一个已知的问题是 Markdown.pl 1.0.1 会忽略单引号包起来的链接 title。* 

+ 隐式链接标记功能让你可以省略指定链接标记，这种情形下，链接标记会视为等同于链接文字，要用隐式链接标记只要在链接文字后面加上一个空的方括号，如果你要 让 "Google" 链接到 google.com，你可以简化成：
    [Google]: []

然后定义链接内容：

由于链接文字可能包含空白，所以这种简化型的标记内也许包含多个单词：

Visit Daring Fireball for more information.

然后接着定义链接：

链接的定义可以放在文件中的任何一个地方，我比较偏好直接放在链接出现段落的后面，你也可以把它放在文件最后面，就像是注解一样。

下面是一个参考式链接的范例：

I get 10 times more traffic from Google than from
Yahoo or MSN.

如果改成用链接名称的方式写：

I get 10 times more traffic from Google than from
Yahoo or MSN.

上面两种写法都会产生下面的 HTML。

<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from
<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>

下面是用行内式写的同样一段内容的 Markdown 文件，提供作为比较之用：

I get 10 times more traffic from Google
than from Yahoo or
MSN.

参考式的链接其实重点不在于它比较好写，而是它比较好读，比较一下上面的范例，使用参考式的文章本身只有 81 个字符，但是用行内形式的却会增加到 176 个字元，如果是用纯 HTML 格式来写，会有 234 个字元，在 HTML 格式中，标签比文本还要多。

使用 Markdown 的参考式链接，可以让文件更像是浏览器最后产生的结果，让你可以把一些标记相关的元数据移到段落文字之外，你就可以增加链接而不让文章的阅读感觉被打断。



#### 强调
Markdown 使用星号 \* 和底线 \_ 作为标记强调字词的符号，被 \* 或 \_ 包围的字词会被转成用&lt;em&gt;
标签包围，用两个 \** 或 \__ 包起来的话，则会被转成&lt;strong&gt;，例如：

single asterisks

single underscores

double asterisks

double underscores_


会转成：

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong>

你可以随便用你喜欢的样式，唯一的限制是，你用什么符号开启标签，就要用什么符号结束。

强调也可以直接插在文字中间：

unfriggingbelievable

但是**如果你的 * 和 _ 两边都有空白的话，它们就只会被当成普通的符号。**

如果要在文字前后直接插入普通的星号或底线，你可以用反斜线：

*this text is surrounded by literal asterisks*

#### 代码

如果要标记一小段行内代码，你可以用反引号把它包起来（`），例如：

Use the printf() function.

会产生：

<p>Use the <code>printf()</code> function.</p>

如果要在代码区段内插入反引号，你可以用多个反引号来开启和结束代码区段：

There is a literal backtick (`) here.

这段语法会产生：

<p><code>There is a literal backtick (`) here.</code></p>

代码区段的起始和结束端都可以放入一个空白，起始端后面一个，结束端前面一个，这样你就可以在区段的一开始就插入反引号：

A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`

会产生：

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>foo</code></p>

在代码区段内，& 和 < 都会被自动地转成 HTML 实体，这使得插入 HTML 原始码变得很容易，Markdown 会把下面这段：

Please don't use any <blink> tags.

转为：

<p>Please don't use any <code><blink></code> tags.</p>

你也可以这样写：

— is the decimal-encoded equivalent of —.

以产生：

<p><code>—</code> is the decimal-encoded
equivalent of <code>—</code>.</p>


#### 图片

很明显地，要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。

Markdown 使用一种和链接很相似的语法来标记图片，同样也允许两种样式： 行内式和参考式。
 + 行内式的图片语法:
+ 行内式的图片语法由：![图片名称]（图片地址)组成
+ 图片名称没有的情况选可以只写空格
+ 图片地址可以是图片的 url 或者是本地图片路径
+ 图片地址后可跟 title 属性，title 不是必须属性，根据需来设置
    ```
  ![](/path/to/img.jpg)

    ![](/path/to/img.jpg "Optional title")

** 参考式的图片语法则长得像这样：**

![Alt text][id]

到目前为止， Markdown 还没有办法指定图片的宽高，如果你需要的话，你可以使用普通的 <img> 标签

其它

自动链接

<wawacai.xin.com>

Markdown 会转为：

<a href="http://wawacai.xin.com">http://wawacai.xin.com</a>

邮址的自动链接也很类似，只是 Markdown 会先做一个编码转换的过程，把文字字符转成 16 进位码的 HTML 实体，这样的格式可以糊弄一些不好的邮址收集机器人，例如：

<address@example.com>

Markdown 会转成：

<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>

在浏览器里面，这段字串其实是

 <a href="mailto:address@example.com">address@example.com </a>

会变成一个可以点击的「address@example.com」链接。

这种作法虽然可以糊弄不少的机器人，但并不能全部挡下来，不过总比什么都不做好些。不管怎样，公开你的信箱终究会引来广告信件的。

反斜杠

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

\*literal asterisks\*

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

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

猜你喜欢

热点阅读