Markdown语法教程

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

背景

优点

  1. 专注于文字内容;
  2. 纯文本,易读易写,可以方便地纳入版本控制;
  3. 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。

使用场景

  • 各类代码托管平台
    主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。
  • 技术社区和写作平台
    StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记
  • 论坛
    V2EX、光谷社区

  各平台可能采用不同语言实现的 Markdown 解析引擎,或采用同一解析引擎的不同版本,而且可能有不同程度的定制与扩展,这导致在不同平台上使用 Markdown 写作时体验并不完全一致。不过幸好对于大家公认的一些标准语法,各家都是支持的。

编辑工具

  理论上任何一款文本编辑器都能用于编辑 Markdown 文档,它们分别提供了不同程度的语法高亮、预览等功能,以下只是列举其中一部分,选择自己称手的即可。

  • 推荐编辑器
    Typora / VS Code
  • 传统编辑器
    Vim / Emacs / Sublime Text / Notepad++
  • IDE 自带编辑器
    IntelliJ IDEA / Android Studio / WebStorm
  • 专用编辑器
    Ulysses / Mou / Markpad
  • 在线编辑器
    CSDN / 简书

语法

标题

Markdown:

# atx-style 一级标题

## 二级标题

###### 六级标题

Setext-style 一级标题
===

二级标题
---

预览效果:

atx-style 一级标题

二级标题

六级标题

Setext-style 一级标题

二级标题

对应 HTML:

<h1>atx-style 一级标题h1>

<h2>二级标题h2>

<h6>六级标题h6>

<h1>Setext-style 一级标题h1>

<h2>二级标题h2>

段落

  中间没有空行的连续不断的几行文字被视为一个段落。

Markdown:

白日依山尽,

黄河入海流。
(句号后面没空格)

欲穷千里目,

更上一层楼。  
(句号后面有俩空格)

预览效果:

白日依山尽,

黄河入海流。
(句号后面没空格)

欲穷千里目,

更上一层楼。
(句号后面有俩空格)

对应 HTML:

<p>白日依山尽,p>

<p>黄河入海流。
(句号后面没有空格)p>

<p>欲穷千里目,p>

<p>
  更上一层楼。
  <br>
  (句号后面有俩空格)
p>

行内格式

  对段落或者部分文本的强调效果。

Markdown:

后面俩字**加黑**

后面俩字*斜体*

预览效果:

后面俩字加黑

后面俩字斜体

对应 HTML:

<p>
  后面俩字
  <strong>加黑strong>
p>
<p>
  后面俩字
  <em>斜体em>
p>

引用块

Markdown:

> 引用块段落一。
>
> 引用块段落二。
>> 内嵌引用块段落一。
>
> ### 引用块内的标题

预览效果:

引用块段落一。

引用块段落二。

内嵌引用块段落一。

引用块内的标题

对应 HTML:

<blockquote>
  <p>引用块段落一。p>
  <p>引用块段落二。p>
  <blockquote>
    <p>内嵌引用块段落一。p>
  blockquote>
  <h3 id="引用块内的标题">引用块内的标题h3>
blockquote>

超链接

  Markdown 支持行内式链接和引用式链接。

Markdown:

行内式 [博学de叫兽](http://zhangchong.xin/ "博学de叫兽") 链接,带 title。

行内式 [博学de叫兽](http://zhangchong.xin/) 链接。

引用式 [博学de叫兽][1] 链接。

引用式 [博学de叫兽][2] 链接,带 title。

[1]: http://zhangchong.xin/
[2]: http://zhangchong.xin/ "博学de叫兽"

预览效果:

行内式 博学de叫兽 链接,带 title。

行内式 博学de叫兽 链接。

引用式 博学de叫兽 链接。

引用式 博学de叫兽 链接,带 title。

对应 HTML:

<p>行内式 <a href="http://zhangchong.xin/" title="博学de叫兽">博客a> 链接,带 title。p>

<p>行内式 <a href="http://zhangchong.xin/">博学de叫兽a> 链接。p>

<p>引用式 <a href="http://zhangchong.xin/">博学de叫兽a> 链接。p>

<p>引用式 <a href="http://zhangchong.xin/" title="博学de叫兽">博学de叫兽a> 链接,带 title。p>

图片

  在超链接的写法前加一个 !,就是引用图片的方法。

Markdown:

![avatar](https://avatar.csdn.net/8/C/2/3_u012102104.jpg)

预览效果:

avatar
对应 HTML:

<img src="https://avatar.csdn.net/8/C/2/3_u012102104.jpg" alt="avatar">

列表

  包括有序列表和无序列表。

Markdown:

- 苹果
- 葡萄
- 榴莲

1. 苹果
2. 葡萄
3. 榴莲

预览效果:

  • 苹果
  • 葡萄
  • 榴莲
  1. 苹果
  2. 葡萄
  3. 榴莲

对应 HTML:

<ul>
  <li>苹果li>
  <li>葡萄li>
  <li>榴莲li>
ul>
<ol>
  <li>苹果li>
  <li>葡萄li>
  <li>榴莲li>
ol>

  其中无序列表的标记可以使用 +-*,有序列表前的数字可以是乱序的。

代码块

  支持行内代码和代码块。

Markdown:
Android 里使用 TextUtils 类的 isEmpty 方法来判断字符串是否为空。

```java
if (TextUtils.isEmpty(text)) {
    return null;
}
```

预览效果:
  Android 里使用 TextUtils 类的 isEmpty 方法来判断字符串是否为空。

if (TextUtils.isEmpty(text)) {
    return null;
}

对应 HTML:

<p>Android 里使用 <code>TextUtilscode> 类的 <code>isEmptycode> 方法来判断字符串是否为空。p>

<div class="highlight highlight-source-java"><pre><span class="pl-k">ifspan> (<span class="pl-smi">TextUtilsspan><span class="pl-k">.span>isEmpty(text)) {
    <span class="pl-k">returnspan> <span class="pl-c1">nullspan>;
}pre>div>

  上例中的语言标记 java 可选填,可用于在编辑器和渲染后的效果里添加语法高亮。块式代码也可以对整个代码段缩进四个空格,或一个 Tab 来实现。

水平分割线

  使用一个单独行里的三个或以上 *- 来生产一条水平分割线,它们之间可以有空格。

Markdown:

***

-----

- - -

预览效果:




对应 HTML:




嵌入 HTML

  Markdown 标记语言的目的不是替代 HTML,也不是发明一种更便捷的插入 HTML 标签的方式。它对应的只是 HTML 标签的一个很小的子集。
  对于那些没有办法用 Markdown 语法来对应的 HTML 标签,直接使用 HTML 来写就好了。

扩展语法

  本节的内容是介绍一些受到广泛支持的 Markdown 扩展语法。

表格

Markdown:

| 编号  | 姓名(左) | 年龄(右) | 性别(中) |
| ----- | :--------  | ---------: | :------:   |
| 0     | 张三       | 28         | 男         |
| 1     | 李四       | 29         | 男         |

预览效果:

编号 姓名(左) 年龄(右) 性别(中)
0 张三 28
1 李四 29

对应 HTML:

<table>
  <thead>
    <tr>
      <th>编号th>
      <th align="left">姓名(左)th>
      <th align="right">年龄(右)th>
      <th align="center">性别(中)th>
    tr>
  thead>
  <tbody>
    <tr>
      <td>0td>
      <td align="left">张三td>
      <td align="right">28td>
      <td align="center">td>
    tr>
    <tr>
      <td>1td>
      <td align="left">李四td>
      <td align="right">29td>
      <td align="center">td>
    tr>
  tbody>
table>

任务列表

  在 GitHub / GitLab 里有较好的支持。

Markdown:

- [x] 洗碗
- [ ] 清洗油烟机
- [ ] 拖地

预览效果:

  • 洗碗
  • 清洗油烟机
  • 拖地

对应 HTML:

<ul class="contains-task-list">
  <li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox" checked=""> 洗碗li>
  <li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> 清洗油烟机li>
  <li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> 拖地li>
ul>

删除线

Markdown:

后面三个字打上~~删除线~~。

预览效果:

后面三个字打上删除线

对应 HTML:

<p>后面三个字打上<del>删除线del>p>

自动链接

  自动链接扩展,即:当识别到 URL,或用 <> 包括的 URL 时,会自动为其生成 a 标签。

Markdown:

http://zhangchong.xin/


预览效果:

http://zhangchong.xin/

[email protected]

对应 HTML:

<p><a href="http://zhangchong.xin/">http://zhangchong.xin/a>p>

<p><a href="mailto:"><[email protected]>a>p>

emoji

  以 GitHub Pages 为例。

Markdown:

:camel: :blush: :smile:

预览效果:

? ? ?

对应 HTML:

<p>
  <img class="emoji" title=":camel:" alt=":camel:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f42b.png" height="20" width="20">
  <img class="emoji" title=":blush:" alt=":blush:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f60a.png" height="20" width="20">
  <img class="emoji" title=":smile:" alt=":smile:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f604.png" height="20" width="20">
p>

拓展进阶

  想象力丰富的工程师们还扩展了很多基于 Markdown 的玩法,包括但不限于:

  • 画流程图和时序图
  • 插入数学公式
  • 用 Markdown 做 PPT
  • 用 Markdown 写微信公众号

你可能感兴趣的:(开发工具)