Markdown 简介

这是我参与更文挑战的第23天,活动详情查看: 更文挑战

概述

想知道 Markdown 是什么,需要先搞清楚一个概念:富文本编辑器。

一般来说,在富文本编辑器输入一段文本,选择具体的格式后,能够直接显示对应的结果。例如我们常见的 Office Word 就是典型的富文本编辑器。

这样做有两个优势:

  1. 简单、直观;
  2. 所见即所得。

但这种方式带来一个难以弥补的缺陷:效率低下。

回想一下,我们在使用 Word 进行内容输出时,往往需要一边「输入文字」,一边用鼠标选择对应样式:加粗、排序、列表等。即便完成内容编辑,最后往往会出现「样式不一致」(大学论文排版时的痛苦)、「不同平台格式不统一」(例如 Word 和 WPS)等。


而Markdown是什么呢?

首先,Markdown是一门标记语言。各位应该知道HTML,Markdown和HTML可以认为是同类事物。简而言之,就是用纯文本的代码描述带格式文本的一种方法。
那么有了HTML,要Markdown有何用?最简单的答案是:HTML太难写了!相比HTML标签,Markdown采用缩进和符号表示格式,这样对于关注内容的作者而言友好了很多,而且即使是Markdown代码也有相当强的可读性。
于是写好Markdown后,如何将其显示成我们想要的格式呢?通常的做法是将Markdown编译为HTML。其实一些网站已经自带了这样的编译器,输入Markdown代码后直接将其转化为HTML,就可以交给浏览器渲染了。Github上的README以及各种.md格式文件的预览功能就是最典型的例子。
Markdown可以广泛用于文档、博客、论坛等带格式文本内容的创作,习惯后使用起来会比所见即所得的HTML编辑器更加方便快捷,较Word等格式又有纯文本这一优势,在上述「非正式场合」相比LaTeX的优势更是不言而喻。

所以 **Markdown 是一种通过标记字符,对内容进行样式更改的语法。**Markdown 的目标是实现「易读易写」。

比方说,在常见的富文本编辑器中,如果我想要**加粗一段话,**需要用鼠标选择对应的文本,然后选择加粗选项或Ctrl+B

但在 Markdown 编辑器中,我只需要在需要加粗的文本开头和结尾加上两个*即可,例如:**加粗这段话**

这种方式避免了富文本编辑器的两个不足:

  1. 使用 Markdown 编辑器时,你则只需要专注内容的输出,无需离开键盘即可完成:编辑(文本字符) – 排版(标记字符);
  2. **最后的呈现结果一致,可预见。**不用担心格式错误或者样式变化。

实际上,现在主流的 Markdown 的编辑器还能够实现富文本编辑器的优势:所见即所得。

Typora为例,在文本编辑过程中,就能够实时预览最终的呈现方式。

当然除了这个,还有一些在线的网站,一般都能够左边文本右边预览,就算不懂语法也可以用图形界面操作。

比如stackedit.io, 还支持MathJax等插件。

区块元素

段落和换行

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

标题

Markdown 支持两种标题的语法,类 [Setext] 1 和类 [atx] 2 形式。

类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:

This is an H1
=============

This is an H2
-------------
复制代码

任何数量的 =- 都可以有效果。

类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如:

# 这是 H1

## 这是 H2

###### 这是 H6
复制代码

你可以选择性地「闭合」类 atx 样式的标题,这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上 #,而行尾的 # 数量也不用和开头一样(行首的井字符数量决定标题的阶数):

# 这是 H1 #

## 这是 H2 ##

### 这是 H3 ######
复制代码

区块引用 Blockquotes

Markdown 标记区块引用是使用类似 email 中用 > 的引用方式。如果你还熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown 文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行的最前面加上 >

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
复制代码

Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
复制代码

区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
复制代码

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码:
> 
>     return shell_exec("echo $input | $markdown_script");
复制代码

列表

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

无序列表使用星号、加号或是减号作为列表标记:

*   Red
*   Green
*   Blue
复制代码

等同于:

+   Red
+   Green
+   Blue
复制代码

也等同于:

-   Red
-   Green
-   Blue
复制代码

有序列表则使用数字接着一个英文句点:

1.  Bird
2.  McHale
3.  Parish
复制代码

列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。

要让列表看起来更漂亮,你可以把内容用固定的缩进整理好:

*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
    viverra nec, fringilla in, laoreet vitae, risus.
*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
    Suspendisse id sem consectetuer libero luctus adipiscing.
复制代码

如果列表项目间用空行分开,在输出 HTML 时 Markdown 就会将项目内容用 <p> 标签包起来,举例来说:

*   Bird
*   Magic
复制代码

会被转换为:

<ul>
<li>Bird</li>
<li>Magic</li>
</ul>
复制代码

但是这个:

*   Bird

*   Magic
复制代码

会被转换为:

<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>
复制代码

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符:

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

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.
复制代码

如果你每行都有缩进,看起来会看好很多,当然,再次地,如果你很懒惰,Markdown 也允许:

*   This is a list item witmarkdownh two paragraphs.

    This is the second paragraph in the list item. You're
    only required to indent the first line. Lorem ipsum dolorsit amet, consectetuer adipiscing elit.

*   Another item in the same list.
复制代码

如果要在列表项目内放进引用,那 > 就需要缩进:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.
复制代码

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

*   一列表项包含一个列表区块:

        <代码写在这>
复制代码

代码区块

插入程序代码的方式有两种:使用反引号 `(~ 键)、使用缩进(Tab)。

  • 插入行内代码,即插入一个单词或者一句代码的情况,使用 code 这样的形式插入。
  • 插入多行代码,分别使用三个反引号(“`)包裹多行代码。或者使用缩进(Tab)。

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown 会用 `

<div class="footer">
    &copy; 2004 Foo Corporation
</div>
复制代码

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

### 分隔线

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

​```markdown
* * *

***

*****

- - -

---------------------------------------
复制代码

区段元素

表格

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |
复制代码
First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

链接

Markdown 支持两种形式的链接语法: _行内式_和_参考式_两种形式。
不管是哪一种,链接文字都是用 [方括号] 来标记。
要建立一个_行内式_的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.
复制代码

会产生:

<p>This is <a href="http://example.com/" title="Title">
an example</a> inline link.</p>

<p><a href="http://example.net/">This link</a> has no
title attribute.</p>
复制代码

如果你是要链接到同样主机的资源,你可以使用相对路径:

See my [About](/about/) page for details.
复制代码

_参考式_的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:

This is [an example][id] reference-style link.
复制代码

你也可以选择性地在两个方括号中间加上一个空格:

This is [an example] [id] reference-style link.
复制代码

接着,在文件的任意处,你可以把这个标记的链接内容定义出来:

[id]: http://example.com/  "Optional Title Here"
复制代码

链接内容定义的形式为:

  • 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
  • 接着一个冒号
  • 接着一个以上的空格或制表符
  • 接着链接的网址
  • 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着

下面这三种链接的定义都是相同:

[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)
复制代码

请注意: 有一个已知的问题是 Markdown.pl 1.0.1 会忽略单引号包起来的链接 title。
链接网址也可以用尖括号包起来:

[id]: <http://example.com/>  "Optional Title Here"
复制代码

你也可以把 title 属性放到下一行,也可以加一些缩进,若网址太长的话,这样会比较好看:

[id]: http://example.com/longish/path/to/resource/here
    "Optional Title Here"
复制代码

网址定义只有在产生链接的时候用到,并不会直接出现在文件之中。
链接辨别标签可以有字母、数字、空白和标点符号,但是并_不_区分大小写,因此下面两个链接是一样的:

[link text][a]
[link text][A]
复制代码

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

[Google][]
复制代码

然后定义链接内容:

[Google]: http://google.com/
复制代码

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

Visit [Daring Fireball][] for more information.
复制代码

然后接着定义链接:

[Daring Fireball]: http://daringfireball.net/
复制代码

链接的定义可以放在文件中的任何一个地方,一般直接放在链接出现段落的后面,你也可以把它放在文件最后面,就像是注解一样。
下面是一个参考式链接的范例:

I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].

  [1]: http://google.com/        "Google"
  [2]: http://search.yahoo.com/  "Yahoo Search"
  [3]: http://search.msn.com/    "MSN Search"
复制代码

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

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

  [google]: http://google.com/        "Google"
  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
  [msn]:    http://search.msn.com/    "MSN Search"
复制代码

上面两种写法都会产生下面的 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](http://google.com/ "Google")
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
[MSN](http://search.msn.com/ "MSN Search").
复制代码

参考式的链接其实重点不在于它比较好写,而是它比较好读,比较一下上面的范例,使用参考式的文章本身只有 81 个字符,但是用行内形式的却会增加到 176 个字元,如果是用纯 HTML 格式来写,会有 234 个字元,在 HTML 格式中,标签比文本还要多。
使用 Markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。

强调

Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被 *_ 包围的字词会被转成用 <em> 标签包围,用两个 *_ 包起来的话,则会被转成 <strong>,例如:

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__
复制代码

会转成:

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong>
复制代码

你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调也可以直接插在文字中间:

un*frigging*believable
复制代码

但是如果你的 **\*****_** 两边都有空白的话,它们就只会被当成普通的符号
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:

\*this text is surrounded by literal asterisks\*
复制代码

删除

~~some text to del~~
复制代码

some text to del

代码

如果要标记一小段行内代码,你可以用反引号把它包起来(“`),例如:

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>
复制代码

图片

很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。
Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式_和_参考式
行内式的图片语法看起来像是:

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")
复制代码

详细叙述如下:

  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 ‘title’ 文字。

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

![Alt text][id]
复制代码

「id」是图片参考的名称,图片参考的定义方式则和连结参考一样:

[id]: url/to/image  "Optional title attribute"
复制代码

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


其它

自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用尖括号包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

<http://example.com/>
复制代码

Markdown 会转为:

<a href="http://example.com/">http://example.com/</a>
复制代码

反斜杠

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

\*literal asterisks\*
复制代码

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

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

Markdown 的局限性

「什么时候该用 Markdown」,其实是个回答非常个性化的问题。为了理清 Markdown 和其他编辑器的边界,与其枚举一个个应用场景,不如把问题改为**「什么时候不该用 Markdown」**。
前面提到,Markdown 只是一个「轻量级标记语言」,相比同为标记语言的 Latex 、Word 或 Pages 这类文字处理软件,更不用说 Indesign 这种专业级的排版软件,Markdown 在排版的功能上显得羸弱。与最熟悉的 Word 相比,稍微对比一下就能发现其中的缺陷:

  1. Markdown 无法对「段落」进行灵活处理。在 Word 中你可以随意插入文本框,调整它的位置。尽管这并不是一个常见的用法,但是这意味着,Word 能以段落为单位进行排版(Latex 也可以做到相似的效果),相比 Markdown 只能线性的对文字排版,专门的排版软件无疑是更能满足专业需求的。
  2. Markdown 对非纯文本元素的排版能力很差,最常见的例子就是图片。诚然,现在很多编辑器都支持了图文混排,但是受制于纯文本格式,Markdown 编辑器几乎不可能做到 Word 一样对图片灵活的调整位置,更不用说文字围绕图片进行自适应排版之类的效果。

可以看出,这些弱势都来源于 Markdown 本身的纯文本格式,因为 Markdown 从一开始就定位为「文字输入工具」,排版功能也是基于 HTML 的延伸,并不适合对排版格式自定义程度较高的文档进行排版。

思考

思考是人类活动的核心之一,而文字则是记录思考的成果最重要的媒介之一。而让绚烂的文学成为实体的工具——笔,也成了人类记忆中不可磨灭的一部分。正如《仲夏夜之梦》中莎士比亚说:

当想象力

使未知事物有了形状

当诗人的笔

让它们成形并给空中的虚无

一处居所

一个名号

参考

Markdown 是什么?

Markdown 完全入门(上)

Markdown 完全入门(下)

Markdown-Syntax-CN

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享