代码区块

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

您可以使用代码块向您的 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'));

您也可以将代码块与 选项卡（tabs）块 结合使用，以在多种不同语言中提供相同的代码示例：

JavaScript

let greeting = function (name) {
  console.log(`Hello, ${name}!`);
};
greeting("Anna");

Ruby

greeting = lambda {|name| puts "Hello, #{name}!"}
greeting.("Anna")

Elixir

greeting = fn name -> IO.puts("Hello, #{name}!") end
greeting.("Anna")

您可以使代码块 跨越窗口的全宽 通过点击位于块旁的 选项菜单 并选择 全宽.

代码块选项

当您点击位于 选项菜单 代码块旁的 操作菜单 或位于块内的

时，您将看到可以设置的多个选项。

设置语法…

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

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

filename.txt

// 一些代码

显示行号

此选项可切换代码的行号显示（开/关）。

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

显示标题

此选项可切换位于代码块顶部、代码行上方的标题显示（开/关）。 标题通常是示例中所示的文件名，，但您也可以将其用作标题、描述或任何您想要的内容。

代码换行

此选项可切换代码换行显示（开/关），这样长行代码将换行并在页面上一次性全部可见。

当代码很长且您想避免读者来回滚动以阅读时，换行显示很有用。如果您开启了 代码换行 ，您可能还想显示行号——这将使代码更易读并更容易理解新行从何处开始。

代码块操作

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

复制代码

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

在 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 %}