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 上)。

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

标题

  • 一级标题: # A first-level title

  • 二级标题: ## A second-level title

  • 三级标题: ### A third-level title

代码块

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

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

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

列表

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

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

  • 1. 以 开始一个编号列表。

  • - [ ] 以 开始一个任务列表。

在编写任何类型的列表时,按下 Tab 以增加缩进,按下 Shift+Tab 以减少缩进。

引用

> 以 创建一个块引用。如果你从头到尾选择整个段落,输入 > 将把内容包裹在块引用中。

这是一个块引用。

分隔线

输入 --- 然后按下 Enter 即可在页面上创建一条分隔线。


这是一条分隔线的示例。

最后更新于

这有帮助吗?