代码块

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

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

当你添加代码块时，你可以选择 设置语法, 显示行号, 显示标题，以及 自动换行。这也很容易 将代码块内容复制到剪贴板，这样你就可以在别处使用它

代码块可能适用于：

• 分享配置

• 添加代码片段

• 分享代码文件

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

• 展示如何调用 API 端点

• 还有更多用途！

代码块示例

index.js

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

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

你还可以将代码块与 选项卡块 结合使用，以多种不同语言提供同一个代码示例：

JavaScript

let greeting = function (name) {
  console.log(`你好，${name}！`);
};
greeting("Anna");

Ruby

Elixir

代码块选项

当你点击 选项菜单 旁边的代码块，或者点击代码块本身中的 操作菜单 时，你会看到一系列可设置的选项。

设置语法…

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

我们使用 Prism 进行语法高亮。你可以使用 Test Drive Prism 来查看 Prism 支持哪些语言。如果你发现 GitBook 和 Prism 之间存在不一致，可能是因为我们的版本落后了一两个版本。我们很快就会跟上！

filename.txt

// 一些代码

带行号

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

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

带标题

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

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

自动换行代码

这会切换代码自动换行的开关，这样过长的代码行就会换行显示，从而在页面上一次性完整可见。

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

可展开

这会切换完整显示代码（当开关关闭时）或显示一个可折叠的代码窗口供用户展开（当开关开启时）。

折叠视图默认显示 10 行代码，并带有一个用于展开完整代码块的按钮。如果代码少于 10 行，则会显示全部内容。

代码块操作

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

复制代码

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

Markdown 中的表示

{% code title="index.js" overflow="wrap" lineNumbers="true" %}

```javascript
‌import * as React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

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

{% endcode %}