Markdown

在编辑器中直接编写 Markdown,使用常见语法轻松创建内容

An image containing the markdown logo
在 GitBook 中编写 Markdown。

GitBook 的编辑器允许你使用 Markdown 创建格式化内容。

Markdown 是一种以简洁著称的流行标记语法。GitBook 支持它作为一种便于键盘输入的方式来编写富文本和结构化文本。

你可以通过访问以下内容了解更多关于 Markdown 本身的信息 Common Mark.

文本格式化

GitBook 支持所有经典的行内 Markdown 格式:

格式
Markdown 版本
结果

加粗

**bold**

bold

斜体

_italic_

italic

删除线

~strikethrough~

strikethrough

行内代码

`code`

code

粘贴 Markdown

当直接将 Markdown 内容粘贴到编辑器中时,重要的是使用 粘贴并匹配样式 选项(通常是 Shift + Cmd + V 在 Mac 上或 Shift + Ctrl + V 在 Windows 上)。

如果你对从其他编辑器或网页复制的内容使用常规粘贴选项,可能会将其作为代码块插入,而不是格式化的文本。

标题

  • 一级标题: # 一级标题

  • 二级标题: ## 二级标题

  • 三级标题: ### 三级标题

代码块

```⏎ 会创建一个新的代码块。

```py⏎ 会创建一个带有 Python 语法高亮的新代码块。

我们使用 Prism 来进行语法高亮。你可以使用 测试 Prism 来检查 Prism 支持哪些语言。如果你发现 GitBook 与 Prism 之间存在不匹配的情况,可能是我们落后了一个或两个版本。我们会尽快跟上!

列表

GitBook 会在你输入时自动检测并创建有序和无序列表。

  • -* 开头一行以开始无序项目符号列表。

  • 1.

  • - [ ] 开头以开始编号列表。

开头以开始任务列表。 在编写任何类型的列表时,按下 Tab 可以增加缩进,按

Shift+Tab

> 可以减少缩进。 > 引用

创建块引用。如果你从头到尾选择整段文字,输入

将把内容包裹在块引用中。 --- 这是一段块引用。 分隔线 输入


然后按下

最后更新于

这有帮助吗?