Markdown language

Markdown 语言的简单使用


Markdown 简介

摘选自 Markdown - wikipedia

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

John Gruber 在 2004 年创造了 Markdown 语言,在语法上有很大一部分是跟亚伦·斯沃茨(Aaron Swartz)共同合作的。这个语言的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成有效的 XHTML (或是HTML)”。 其中最重要的设计是可读性,也就是说这个语言应该要能直接在字面上的被阅读,而不用被一些格式化指令标记 (像是 RTF 与 HTML)。 因此,它是现行电子邮件标记格式的惯例,虽然它也借鉴了很多早期的标记语言,如:setext、Texile、reStructuredText。 许多网站都使用 Markdown 或是其变种,例如:GitHub、reddit、Diaspora、Stack Exchange、OpenStreetMap 与 SourceForge 让用户更利于讨论。

Markdown同时还是一个由Gruber编写的Perl脚本:Markdown.pl。它把用markdown语法编写的内容转换成有效的、结构良好的XHTML或HTML内容,并将左尖括号(‘<’)和&号替换成它们各自的字符实体引用。它可以用作单独的脚本,Blosxom和Movable Type的插件又或者BBEdit的文本过滤器.

Markdown也已经被其他人用Perl和别的编程语言重新实现,其中一个Perl模块放在了CPAN(Text::Markdown)上。它基于一个BSD风格的许可证分发并可以作为几个内容管理系统的插件。

宗旨

Markdown 语法说明 (简体中文版) - wowubuntu

Markdown 的目标是实现「易读易写」。

可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。

总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。


Markdown 语法

标题

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

显示如下:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

一级和二级标题还有一种写法:

1
2
3
4
5
一级标题
===================

二级标题
--------------------

显示如下:

一级标题

二级标题


换行

在行尾输入两个或以上的空格,然后回车


列表

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

1
2
3
- 列表1
- 列表2
- 列表3

显示如下:

  • 列表1
  • 列表2
  • 列表3

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

1
2
3
1. 列表1
2. 列表2
3. 列表3

显示如下:

  1. 列表1
  2. 列表2
  3. 列表3

水平分区线

1
2
3
4
5
* * *
***
*****
- - -
---------------------------------------

链接

1
[显示的文字](url)

显示如下:
显示的文字

另一种选择是,链接地址可以放在段落后面的脚注,前面放上链接引用标签区分。举例说,先在内容行内插入以下内容:

1
[链接文字][链接引用标签]

然后在段落的后面(或者文档的结尾)放上以下内容,就可以生成一个链接:

1
[链接引用标签]: 链接地址 "链接标题"

图片

1
![](url)

显示如下:


引用:

单行引用:

1
2
> 引用的文字
>> 嵌套的引用

显示如下:

引用的文字

嵌套的引用

单行代码引用:

1
`单行代码`

显示如下:
单行代码

多行代码引用:

```
多行代码引用
```


字体

粗体:

1
**粗体文字**

显示如下:
粗体文字

斜体:

1
*斜体文字*

显示如下:
斜体文字


表格

1
2
3
4
5
| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |

显示如下:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

: 为对齐方式, 缺省则为左对齐


(The End)


作者

Cheng

发布于

2018-08-13

更新于

2022-08-06

许可协议

评论