Markdown 语法指南

fenbox
English

基本语法

代码

如果你只想高亮语句中的某个函数名或关键字,可以使用反引号 `function_name()` 实现。

通常编辑器根据代码片段适配合适的高亮方法,但你也可以用 ` 包裹一段代码,并指定一种语言,示例:

```javascript
$(document).ready(function () {
    alert('hello world');
});
```

也可以使用 4 空格缩进,再贴上代码,实现相同的的效果:

····def g(x):
····    yield from range(x, 0, -1)
····yield from range(x)

如你不需要代码高亮,可以用下面的方法禁用:

```nohighlight
// 代码内容
```

标题

文章内容较多时,可以用标题分段:

## 大标题

### 中标题

#### 小标题

粗体、斜体

**粗体文本**

*斜体文本*

***粗斜体文本***

链接

常用链接:

文字链接 [SegmentFault](https://segmentfault.com)
网址链接 <https://segmentfault.com>

高级链接:

这个链接用 1 作为网址变量 [Google][1]
这个链接用 yahoo 作为网址变量 [Yahoo][yahoo]
然后在文档的结尾为变量赋值(网址)

[1]: http://www.google.com
[yahoo]: http://www.yahoo.com

列表

无序列表

* 列表文本前使用 `减号 + 空格`
+ 列表文本前使用 `加号 + 空格`
- 列表文本前使用 `星号 + 空格`

有序列表

1. 列表前使用 `数字 + . + 空格`
2. 我们会自动帮你添加数字
7. 不用担心数字不对,显示的时候我们会自动把这行的 7 纠正为 3

列表嵌套

1. 列出所有元素:

···- 无序列表元素 A
······1. 元素 A 的有序子列表
······2. 元素 A 的有序子列表
···- 前面加三个空格

2. 列表里的多段换行:

···新的一个段落
···这样换行,整体的格式不会乱

3. 列表里引用:

···> 引用内容
···> 引用内容

4. 列表里代码段:

···```
···前面三个空格,之后用三个反引号形成代码块
···```

·······或者直接空七个,引入代码块

引用

普通引用

> 引用文本前使用 `大于号 + 空格`
> 折行可以不加,新起一行都要加上哦

嵌套引用

> 最外层引用
> > 第二层引用
> > > 可以嵌套很多层

引用里嵌套列表

> - 这是引用里嵌套的一个列表
> - 还可以有子列表
> ··- 子列表
> ··- 子列表

引用里嵌套代码块

> ····同样的,在前面加四个空格形成代码块
>  
> ```
> 或者使用三个反引号形成代码块
> ```

图片

跟链接的方法区别在于前面加了个感叹号 !,这样是不是觉得好记多了呢?

![图片名称](http://图片网址)

当然,你也可以像网址那样对图片网址使用变量

这个链接用 1 作为网址变量 [Google][1].
然后在文档的结尾位变量赋值(网址)

[1]: http://www.google.com/logo.png

换行

如果另起一行,只需在当前行结尾加 2 个空格:

在当前行的结尾加 2 个空格··
这行就会新起一行

如果是要起一个新段落,只需要空出一行即可。

分隔符

如果你有写分割线的习惯,可以新起一行输入三个减号 -。当前后都有段落时,请空出一行:

前面的段落

---

后面的段落

高级技巧

行内 HTML 元素

目前只支持部分段内 HTML 元素效果,包括 <kdb> <b> <i> <em> <sup> <sub> <br>

键位显示

使用 <kbd>Enter</kbd> 键换行

代码块

使用 <pre></pre> 元素同样可以形成代码块

粗斜体

<b>Markdown 在此处同样适用,如 **加粗**</b>

符号转义

如果你的描述中需要用到 markdown 的符号,比如 _#* 等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 \_\#\* 进行避免。

\*不想这里的文本变斜体\*
\*\*不想这里的文本被加粗\*\*

扩展

支持 jsfiddlegistcodepen,直接填写 URL,在其之后会自动添加预览点击会展开相关内容:

https://jsfiddle.net/{{ name }}/{{ id }}/
https://gist.github.com/{{ name }}/{{ id }}
https://codepen.io/{{ name }}/pen/{{ id }}

脚注

Markdown[^1] 可以提高排版效率,并将文本转换为 HTML[^html]

[^1]: Markdown 是一种纯文本标记语言
[^html]: HyperText Markup Language 超文本标记语言

公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

$$ E=mc^2 $$

$$
E=mc^2
$$

如果要使用行内公式,可以在公式前后用 \\(\\) 包裹实现:

\\( E=mc^2 \\)
阅读 1.6k

社区指南
SegmentFault 社区指南
avatar
fenbox
SegmentFault PD

主业设计,副业写代码

6.3k 声望
557 粉丝
0 条评论
你知道吗?

avatar
fenbox
SegmentFault PD

主业设计,副业写代码

6.3k 声望
557 粉丝
宣传栏