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 进行语法高亮。你可以使用 Test Drive Prism 来检查 Prism 支持哪些语言。如果你发现 GitBook 与 Prism 之间存在不匹配,可能是我们落后了一个或两个版本。我们会尽快跟上!

列表

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

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

  • 以以下内容开始一行 1. 以开始编号列表。

  • 以以下内容开始一行 - [ ] 以开始任务列表。

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

引用

以以下内容开始一行 > 以创建块引用。如果你从头到尾选中整个段落,输入 > 会将内容包裹为块引用。

这是一个块引用。

分隔线

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


这是一条分隔线的示例。

最后更新于

这有帮助吗?