Markdown

Reading time ~17 minutes

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

Markdown 官方文档


为什么选择 Markdown


  • 它基于纯文本,方便修改和共享
  • 几乎可以在所有的文本编辑器中编写
  • 有众多编程语言的实现,以及应用的相关扩展
  • GitHub 等网站中有很好的应用
  • 很容易转换为 HTML 文档或其他格式
  • 适合用来编写文档、记录笔记、撰写文章

Markdown 基础语法


1. 段落与换行


  • 段落的前后必须是空行
  • 行尾插入至少两个空格以手动换行
  • 想实现段首缩进,推荐全角模式(一般的中文输入法都是按 shift + space)下输入两个空格

2. 标题


2.1 Setext-式

标题 1
========

标题 2
--------

标题 1

标题 2

2.2 atx-式

结尾的 # 可以省略

# 标题 1 #

## 标题 2 ##

###### 标题 6

标题 1

标题 2

标题 6

3. 引用


> 这是第一层引用
>
> > 引用可以嵌套,这是第二层引用(不同平台下的显示效果可能不同)
>
> 回到第一层
> 
> ### 引用内的标题
> - 引用内的
> - 列表

效果:

这是第一层引用

引用可以嵌套,这是第二层引用(不同平台下的显示效果可能不同)

回到第一层

引用内的标题

  • 引用内的
  • 列表

4. 强调


*italic*   **bold**  ***italic&bold***  
_italic_   __bold__  ___italic&bold___

italic bold italic&bold
italic bold italic&bold

5. 列表


5.1 有序列表

1. 以数字和 `.` 开始
2. 注意 `.` 和文字之间要有空格
4. 数字序列不影响生成列表序列
  1. 以数字和 . 开始
  2. 注意 . 和文字之间要有空格
  3. 数字序列不影响生成列表序列

5.2 无序列表

- 以 `-` 或 `*` 或 `+` 开始
- 注意符号和文字之间要有空格
  • -*+ 开始
  • 注意符号和文字之间要有空格

5.3 列表嵌套

1. 项目一
	- 特点一
	- 特点二
2. 项目二
	1. 分项一
	2. 分项二
3. 项目三
  1. 项目一
    • 特点一
    • 特点二
  2. 项目二
    1. 分项一
    2. 分项二
  3. 项目三

6. 链接


6.1 行内式

[Markdown: Dingus](http://daringfireball.net/projects/markdown/dingus "Dingus")

Markdown: Dingus

6.2 参考式

[Markdown: Dingus][dingus]

[dingus]: http://daringfireball.net/projects/markdown/dingus "Dingus"

Markdown: Dingus

注:链接定义可以在文档内其他任何地方,标题(如例中的”Dingus”)可不写。

7. 图片


行内式:

![Markdown](http://fcruzbello.es/wp-content/uploads/Markdown.png "markdown")

参考式:

![Markdown][markdown]

[markdown]: http://fcruzbello.es/wp-content/uploads/Markdown.png "markdown"

标题可选,效果如本文开头所示。

8. 代码


8.1 行内代码

用反引号包裹你想要高亮的代码,如 `<h1>Markdown</h1>`

效果:

用反引号包裹你想要高亮的代码,如 <h1>Markdown</h1>

8.2 代码块

使用至少 4 个空格或 1 个 Tab 缩进:

	$(document).ready(function () {
		alert("Hello World!");
	});

或用 ``` 包裹一段代码,并指定一种语言:

```javascript
$(document).ready(function () {
	alert("Hello World!");
});
```

效果:

$(document).ready(function () {
	alert("Hello World!");
});

9. 分割线


三个以上的 -*_

---

* * * 

_ _ _ _

效果:




10. 注意


  不同的Markdown解释器或工具对相应语法(扩展语法)的解释效果不尽相同,具体可参见工具的使用说明。

埋点上报

前端埋点上报代码片段 Continue reading

批量上报

Published on November 16, 2023

页面打开成功率

Published on November 15, 2023