什么是 Markdown

什么是 Markdown?Markdown 是一种轻量级的「标记语言」,通常为程序员群体所用,目前它已是全球最大的技术分享网站 GitHub 和技术问答网站 StackOverFlow 的御用书写格式。

https://markdown.com.cn/


基本语法

这些是 John Gruber 的原始设计文档中列出的元素。所有 Markdown 应用程序都支持这些元素。

标题

1
2
3
4
5
6
7
8
9
10
11
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

渲染为

title.png

引用块(Blockquote)

1
2
3
4
5
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> > The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

渲染为

Dorothy followed her through many of the beautiful rooms in her castle.

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

带有标题的引用快:

1
2
3
4
5
6
> ### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> _Everything_ is going according to **plan**.

The quarterly results look great!

  • Revenue was off the chart.

  • Profits were higher than ever.

    Everything is going according to plan.

代码(Code)

1
2
3
`code`

`` Use `code` in your Markdown file. ``

渲染为

code

Use `code` in your Markdown file.

要创建代码块,请将代码块的每一行缩进至少四个空格或一个制表符。

1
2
3
4
<html>
<head>
</head>
</html>
<html>
  <head>
  </head>
</html>

分隔线(Horizontal Rule)

至少一个以上的

1
2
3
4
5
---

---

---

渲染结果:




链接(Link)

1
2
3
4
5
[title](https://www.example.com)<br>
这是一个链接 [Markdown 语法](https://markdown.com.cn '最好的markdown教程')。<br>
`网址和 Email 地址:`<br>
<https://markdown.com.cn><br>
<fake@example.com><br>

渲染为

title
这是一个链接 Markdown 语法
网址和 Email 地址:
https://markdown.com.cn
fake@example.com

图片(Image)

1
2
3
![图片名称](https://file.mo7.cc/lxh_gif/lxh_22.gif '图片hover上之后显示的文字')

[![点击图片打开网址](https://file.mo7.cc/lxh_gif/lxh_21.gif '罗小黑')](https://mo7.cc)

渲染为

图片名称

点击图片打开网址

表格(Table)

1
2
3
4
| Syntax    | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |

渲染结果:

Syntax Description
Header Title
Paragraph Text

围栏代码块(Fenced Code Block)

block.png

渲染为:

1
2
3
4
5
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}

删除线(Strikethrough)

1
~~The world is flat.~~

像这样

The world is flat.

段落

1
2
3
4
5
I really like using Markdown.

I think I'll use it to format all of my documents from now on. \
I think I'll use \
I think I'll use it to format all of my documents from now on.

渲染为:

I really like using Markdown.

I think I’ll use it to format all of my documents from now on.
I think I’ll use
I think I’ll use it to format all of my documents from now on.

段落于段落之间添加一行空行就可以了
不要用空格(spaces)或制表符( tabs)缩进段落。

换行语法

目前换行语法存在争议,市面上流行的换行语法有三种

末尾空格

1
2
This is the first line.
And this is the second line.

末尾斜杠

1
2
This is the first line.\
And this is the second line.

<br>标签

1
2
This is the first line.<br>
And this is the second line.

This is the first line.

And this is the second line.

兼容性最好的莫过于末尾
标签了

强调语法

粗体
斜体
粗斜体

1
2
3
I **Love** You <br>
I _Love_ You <br>
This is really **_very_** important text.

I Love You

I Love You

This is really very important text.

有序列表(Ordered List)

1
2
3
1. First item
2. Second item
3. Third item

渲染为

  1. First item
  2. Second item
  3. Third item

无序列表(Unordered List)

1
2
3
- First item
- Second item
- Third item

渲染为

  • First item
  • Second item
  • Third item

任务列表(Task List)

1
2
3
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

渲染为

  • [x] Write the press release
  • [ ] Update the website
  • [ ] Contact the media

通常列表之间可以嵌套

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1.  一级条目
2. 一级条目
- 二级条目
- 二级条目
- [ ] 三级条目
- 三级条目
- 四级条目
- [ ] 四级条目
- [ ] 四级条目
- 四级条目
- 三级条目
* 二级条目
3. 一级条目
4. 一级条目
> 这里引用
5. 一级条目

四个tab为一个块

6. 一级条目
  1. 一级条目

  2. 一级条目

    • 二级条目
    • 二级条目
      • [ ] 三级条目
      • 三级条目
        • 四级条目
        • [ ] 四级条目
        • [ ] 四级条目
        • 四级条目
      • 三级条目
    • 二级条目
  3. 一级条目

  4. 一级条目

    这里引用

  5. 一级条目

    四个tab为一个块
    
  6. 一级条目

转义符

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符\

1
2
\*\*这行文字没有被加粗\*\* \
\* Without the backslash, this would be a bullet in an unordered list.

**这行文字没有被加粗**
* Without the backslash, this would be a bullet in an unordered list.

内嵌 HTML 标签

一般情况下,markdown 都支持内嵌 HTML 语法

<div><table><pre><p> 等,请在其前后使用空行(blank lines)与其它内容进行分隔。


扩展语法

这些元素通过添加额外的功能扩展了基本语法。但是,并非所有 Markdown 应用程序都支持这些元素。

脚注(Footnote)

1
2
Here's a sentence with a footnote. [^1]
[^1]: This is the footnote.

渲染结果:

Here’s a sentence with a footnote. [^1]
[^1]: This is the footnote.

标题编号(Heading ID)

1
### My Great Heading {#custom-id}

渲染出来的 html 像这样

1
<h3 id="custom-id">My Great Heading</h3>

工具与格式化

一般 Markdown 文件的后缀名为 .md技术说明.md

我编写 markdown 时采用的是 VScode,非常强大\

再配合两款插件
markone.png
prettire.png
markdown 的写作体验非常好

prettier 主要用作 markdown 的格式化问题

图床问题

个人史是白嫖七牛云的图片服务器,然后配合

qinium.png
写作的时候一边截图然后直接复制进图床,copy 链接到 Markdown 中就好了

推荐客户端

qiapp.png

下载地址:
https://github.com/willnewii/qiniuClient


结束语

当掌握 Markdown 时,写作分享也可以是一种享受