Markdown 语法指南

基本语法

代码

如果你只想高亮语句中的某个函数名或关键字,可以使用反引号 `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 \\)

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

主业设计,副业写代码

6.5k 声望
754 粉丝
0 条评论
推荐阅读
社区维基:将你的问答捐赠给社区
小王初学编程的时候,在 SegmentFault 提出了许多相关的问题。在社区热心人的帮助下,小王的问题一个个得到了解决,编程技术进步神速。

fenbox15阅读 14k评论 9

封面图
SegmentFault 新手上路
欢迎来到 SegmentFault 思否社区。SegmentFault 是一个面向专业程序员和编程爱好者的技术社区。它由问答和专栏两大块组成,由热心的程序员们创建和维护。在大家的帮助和努力下,我们正在建立一个详细、严谨、高质...

fenbox204阅读 10.7k评论 55

封面图
权威发布 | SegmentFault 思否 2022 年度 Top Writer
2022 年是思否社区成立的第 10 年, “10” 这个数字不论在十进制还是计算机世界的二进制里都表示一次进位,而这一年对思否同样意义重大。

SegmentFault思否16阅读 1.6k评论 1

封面图
SegmentFault 临时封禁 ChatGPT
ChatGPT 是 OpenAI 推出的优化对话的语言模型,该模型可以根据上下文生成自然语言文本来模拟人类对话,实现回答问题、追问问题、指出问题中的错误等功能。简单来说,向 ChatGPT 输入清晰整洁的问题,大概率可以获...

SegmentFault思否16阅读 2.2k评论 9

开源问答社区软件 Answer 1.0 正式版发布!
这是继 10 月 Alpha 版本发布后的首个正式版本。你可以使用 Answer 高效地搭建一个问答知识社区,并用于产品技术问答、客户支持、用户交流等场景。

AnswerDev7阅读 2.4k评论 1

封面图
技术社区的朋友们,让我们在 2050 团聚吧!
提到 2050 你会想到什么? ——第一批 00 后步入 50 岁,刚刚出生的孩子们成为这个世界的中流砥柱;如科幻般的世界:上天下地、无尽探索、发达的医疗、先进的交通;

SegmentFault思否5阅读 12.9k评论 1

“百度一下”后,你想得到什么样的答案?
“百度一下,你就知道。” 2005 年,百度提出了这句经典的 Slogan。这句 Slogan 除了在一定程度上帮助百度奠定了国内搜索引擎领域不可动摇的霸主地位,同样也培养出了国内用户的搜索意识。

思否编辑部6阅读 17.2k

封面图
avatar
fenbox
SegmentFault PD

主业设计,副业写代码

6.5k 声望
754 粉丝
宣传栏