4

什么是 Markdown

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

为什么设计 Markdown

Markdown 这个语言的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成有效的 XHTML (或是HTML)”。其中最重要的设计是可读性,也就是说这个语言应该要能直接在字面上被阅读,而不用被一些格式化指令标记 (如RTF与HTML)。

相比于 HTML,Markdown 更加精简,更加注重内容,其主要宗旨是易读易写。一般 Markdown 最终都是要转换为 HTML,用于个人博客或网页。但借助于某些 Markdown 编辑器 (如Typora),我们可以将 Markdown 转换为 PDF、Word、LaTeX、Image 等常见的文件格式。

为什么选择 Markdown

选择 Markdown 的理由只有一个:简单方便、节省时间。

优点

  • 语法简洁 - 没有编程基础的初学者,可以快速入门。

  • 注重内容 - 专注于内容编写,不再为格式排版而苦恼。

  • 易于阅读 - 即便没有经过转换的 Markdown 文件,大部分内容仍可直接阅读。

  • 跨平台性 - 任何平台均能打开 Markdown 文件,由于是纯文本文件,不存在格式兼容的问题。

  • 导出方便 - 方便导出为 HTML、PDF、Word(.docx)、LaTeX 等常见格式。

缺点

  • 语法兼容 - 基础语法是兼容的,但不同工具(平台)的扩展语法不兼容(由于没有统一标准)。

  • 细节控制 - Markdown只提供最基础的格式,其显示样式主要由CSS控制,很难针对性的控制部分内容。

Markdown 基础语法

标题

语法:

# 第一级标题 `<h1>`
## 第二级标题 `<h2>`
...
### 第六级标题 `<h6>`

结果:

第一级标题 <h1>

第二级标题 <h2>

第六级标题 <h6>


强调

粗体

语法:

**这些文字会被加粗**
__这些文字会被加粗__

结果:

这些文字会被加粗
这些文字会被加粗

斜体

语法:

*这些文字的效果会是斜体*

结果:

这些文字的效果会是斜体

换行

四个以上的空格加回车

无序列表

语法:

* 项目一 无序列表 `* + 空格键`
* 项目二
    * 项目二的子项目一 无序列表 `TAB + * + 空格键`
    * 项目二的子项目二

结果:

  • 项目一 无序列表 * + 空格键

  • 项目二

    • 项目二的子项目一 无序列表 TAB + * + 空格键

    • 项目二的子项目二

有序列表

语法:

1. 项目一 有序列表 `数字 + . + 空格键`
2. 项目二 
3. 项目三
    1. 项目三的子项目一 有序列表 `TAB + 数字 + . + 空格键`
    2. 项目三的子项目二

结果:

  1. 项目一 有序列表 数字 + . + 空格键

  2. 项目二

  3. 项目三

    1. 项目三的子项目一 有序列表 TAB + 数字 + . + 空格键

    2. 项目三的子项目二

任务列表

语法:

- [ ] 任务一 未做任务 `- + 空格 + [ ]`
- [x] 任务二 已做任务 `- + 空格 + [x]`

结果:

  • [ ] 任务一 未做任务 - + 空格 + [ ]

  • [x] 任务二 已做任务 - + 空格 + [x]

图片

语法:

 ![Alt Text](url)
 示例:
 ![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)

结果:

GitHub set up

链接

邮箱链接

语法:

Email链接 <example@example.com>

结果:

Email链接 <example@example.com>

普通链接

语法:

[GitHub](http://github.com)

结果:

GitHub

区块引用

简单使用

语法:

某某说:
> 第一行引用
> 第二行引用文字

结果:

某某说:

第一行引用
第二行引用文字

进阶使用

语法:

>**日常工作**
>* 吃饭
>* 睡觉
>* 打豆豆

结果:

日常工作

  • 吃饭

  • 睡觉

  • 打豆豆

引用嵌套

语法:

>对多数职场人来说,打造有价值的个人品牌非常必要。
>>它能让你告别低水平的勤奋陷阱,让你工作时间越久越值钱,让你成为职场的甲方,不再委屈和焦虑。

结果:

对多数职场人来说,打造有价值的个人品牌非常必要。

它能让你告别低水平的勤奋陷阱,让你工作时间越久越值钱,让你成为职场的甲方,不再委屈和焦虑。

行内代码

语法:

`<html>` `Markdown`

结果:

<html> Markdown

多行或代码段

语法:

 /```js
  // 实际语法是:```***```
  function add(a, b) {
    return a + b;
  }
 /```

结果:

 function add(a, b) {
   return a + b;
 }

表格

语法:

第一格表头 | 第二格表头
--------- | -------------
内容单元格 第一列第一格 | 内容单元格第二列第一格
内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格

结果:

第一格表头 第二格表头
内容单元格 第一列第一格 内容单元格第二列第一格
内容单元格 第一列第二格 多加文字 内容单元格第二列第二格

删除线

语法:

~~我被删除了,呜呜~~

结果:

我被删除了,呜呜

下划线

语法:

_我有下划线_

结果:

我有下划线

分割线

语法:

***
*****
- - -

结果:



反斜杠

语法:

\*这里不会显示斜体\*

结果:

*这里不会显示斜体*

其它高级语法

  • TOC - 内容目录 (存在兼容性)

  • 脚注 - 这是一个脚注[^footnote]

  • 标签和分类

  • 流程图和时序图

  • LaTeX 公式

Markdown 编辑器

了解更多的信息,请查看 Markdown 编辑器推荐

参考资源


阿宝哥
15.8k 声望10.2k 粉丝

聚焦全栈,专注分享 Angular、TypeScript、Node.js/Java 、Spring 技术栈等全栈干货