代码块

向页面添加代码块,以包含示例代码、配置、代码片段等

你可以使用代码块向你的 GitBook 页面添加代码。

添加代码块时,你可以选择 设置语法, 显示行号, 显示标题,并且 自动换行。此外,你也可以轻松地 将代码块内容复制到剪贴板,以便在其他地方使用

代码块可用于:

  • 共享配置

  • 添加代码片段

  • 共享代码文件

  • 展示命令行工具的使用示例

  • 展示如何调用 API 端点

  • 还有更多用途!

添加代码块

  1. 要添加代码块,请将光标放在空白行上并输入 /.

  2. 在快速插入菜单中,选择 代码块.

  3. GitBook 会插入该块并将光标放在其中,方便你粘贴或输入代码。

代码块示例

index.js
import * as React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, window.document.getElementById('root'));

你也可以将代码块与 标签块 结合使用,以多种不同语言提供同一个代码示例:

代码块选项

当你点击 选项菜单 The Options menu icon in GitBook ,或点击 操作菜单 The Actions menu icon in GitBook 时,你会看到一些可设置的选项。

设置语法…

你可以将代码块的语法设置为任何受支持的语言。这样也会启用该语言的语法高亮。

circle-info

我们使用 Prismarrow-up-right 进行语法高亮。你可以使用 Test Drive Prismarrow-up-right 查看 Prism 支持哪些语言。如果你发现 GitBook 与 Prism 之间不一致,可能是我们落后了一两个版本。我们会尽快跟上!

带行号

这将切换代码行号的显示与隐藏。

当代码整体代表某个文件的内容,或者代码块很长、行数很多时,显示行号会很有用。对于代码片段、命令行使用说明、终端表达式以及类似场景,隐藏行号会更有用。

带标题

这将切换显示一个位于块顶部、代码行上方的标题。

该标题通常是文件名,如 上面的示例所示,但你也可以将其用作标题、说明,或任何你想要的内容。

代码自动换行

这将切换代码自动换行,因此较长的代码行会换行显示,让所有内容都能一次性在页面上看到。

当代码很长、你想避免查看者来回滚动阅读时,换行会很有用。如果你将 代码自动换行 打开,你可能还想显示行号——这会让阅读代码并理解新行从哪里开始更容易。

可展开

这将切换为完整显示代码(当开关关闭时)或显示一个可折叠的代码窗口,用户可以展开它(当开关打开时)。

折叠视图默认显示 10 行代码,并提供一个可展开按钮以显示完整代码块。如果代码少于 10 行,则会显示全部内容。

代码块操作

除了上面的选项外,你还可以更改代码块显示的语言,并立即复制你的代码。

复制代码

将鼠标悬停在代码块上,会出现一些图标。点击中间的图标即可将代码块内容复制到剪贴板。

Markdown 表示形式

最后更新于

这有帮助吗?