代码块

文档中的代码块功能强大 💪。

代码标题

通过在语言后添加 title 键（它们之间留一个空格），你可以为代码块添加标题。

```jsx title="/src/components/HelloCodeTitle.js"
function HelloCodeTitle(props) {
  return <h1>Hello, {props.name}</h1>;
}
```

http://localhost:3000

/src/components/HelloCodeTitle.js
function HelloCodeTitle(props) {
  return <h1>Hello, {props.name}</h1>;
}

语法高亮

代码块是由三个反引号包围的文本块。你可以查看这个参考以了解 MDX 的规范。

```js
console.log('Every repo must come with a mascot.');
```

使用与你的代码块匹配的语言元字符串，Docusaurus 将自动进行语法高亮，由 Prism React Renderer 提供支持。

http://localhost:3000

console.log('Every repo must come with a mascot.');

主题

默认情况下，我们使用的 Prism 语法高亮主题是 Palenight。你可以通过在 docusaurus.config.js 的 themeConfig 中传递 prism 的 theme 字段来更改为另一个主题。

例如，如果你更喜欢使用 dracula 高亮主题：

docusaurus.config.js
import {themes as prismThemes} from 'prism-react-renderer';

export default {
  themeConfig: {
    prism: {
      theme: prismThemes.dracula,
    },
  },
};

因为 Prism 主题只是一个 JS 对象，如果你对默认主题不满意，你也可以编写自己的主题。Docusaurus 增强了 github 和 vsDark 主题以提供更丰富的高亮，你可以查看我们的亮色和暗色代码块主题的实现。

支持的语言

默认情况下，Docusaurus 附带了常用语言的子集。

注意

一些流行的语言如 Java、C# 或 PHP 默认未启用。

要为任何其他 Prism 支持的语言添加语法高亮，请在附加语言数组中定义它。

备注

每种附加语言都必须是有效的 Prism 组件名称。例如，Prism 会将语言 cs 映射到 csharp，但只存在 prism-csharp.js 作为组件，所以你需要使用 additionalLanguages: ['csharp']。你可以查看 node_modules/prismjs/components 以找到所有可用的组件（语言）。

例如，如果你想为 PowerShell 语言添加高亮：

docusaurus.config.js
export default {
  // ...
  themeConfig: {
    prism: {
      additionalLanguages: ['powershell'],
    },
    // ...
  },
};

添加 additionalLanguages 后，重新启动 Docusaurus。

如果要为 Prism 尚不支持的语言添加高亮，你可以 swizzle prism-include-languages：

npm
Yarn
pnpm
Bun

npm run swizzle @docusaurus/theme-classic prism-include-languages

yarn swizzle @docusaurus/theme-classic prism-include-languages

pnpm run swizzle @docusaurus/theme-classic prism-include-languages

bun run swizzle @docusaurus/theme-classic prism-include-languages

它将在你的 src/theme 文件夹中生成 prism-include-languages.js。你可以通过编辑 prism-include-languages.js 为自定义语言添加高亮支持：

src/theme/prism-include-languages.js
const prismIncludeLanguages = (Prism) => {
  // ...

  additionalLanguages.forEach((lang) => {
    require(`prismjs/components/prism-${lang}`);
  });

  require('/path/to/your/prism-language-definition');

  // ...
};

编写自定义语言定义时，可以参考 Prism 的官方语言定义。

添加自定义语言定义时，无需将语言添加到 additionalLanguages 配置数组，因为 Docusaurus 仅在 Prism 提供的语言中查找 additionalLanguages 字符串。在 prism-include-languages.js 中添加语言导入就足够了。

行高亮

使用注释高亮

你可以使用带有 highlight-next-line、highlight-start 和 highlight-end 的注释来选择要高亮的行。

```js
function HighlightSomeText(highlight) {
  if (highlight) {
    // highlight-next-line
    return 'This text is highlighted!';
  }

  return 'Nothing highlighted';
}

function HighlightMoreText(highlight) {
  // highlight-start
  if (highlight) {
    return 'This range is highlighted!';
  }
  // highlight-end

  return 'Nothing highlighted';
}
```

http://localhost:3000

function HighlightSomeText(highlight) {
  if (highlight) {
    return 'This text is highlighted!';
  }

  return 'Nothing highlighted';
}

function HighlightMoreText(highlight) {
  if (highlight) {
    return 'This range is highlighted!';
  }

  return 'Nothing highlighted';
}

支持的注释语法：

风格	语法
C 风格	`/* ... */` 和 `// ...`
JSX 风格	`{/* ... */}`
Bash 风格	`# ...`
HTML 风格	`<!-- ... -->`

我们会尽力根据语言推断要使用哪组注释风格，并默认允许所有注释风格。如果有当前不支持的注释风格，我们欢迎添加！欢迎提交 Pull Request。请注意，不同的注释风格没有语义差异，只有它们的内容才有差异。

你可以在 src/css/custom.css 中设置自己的高亮代码行背景色，以更好地适应你选择的语法高亮主题。下面给出的颜色适用于默认高亮主题（Palenight），所以如果你使用其他主题，你需要相应调整颜色。

/src/css/custom.css
:root {
  --docusaurus-highlighted-code-line-bg: rgb(72, 77, 91);
}

/* 如果你在暗黑模式下有不同的语法高亮主题。 */
[data-theme='dark'] {
  /* 适用于暗黑模式语法高亮主题的颜色 */
  --docusaurus-highlighted-code-line-bg: rgb(100, 100, 100);
}

如果你还需要以其他方式为高亮代码行设置样式，可以定位 theme-code-block-highlighted-line CSS 类。

使用元字符串高亮

你也可以在语言元字符串中指定高亮行范围（在语言后留一个空格）。要高亮多行，用逗号分隔行号或使用范围语法选择一段行。此功能使用 parse-number-range 库，你可以在其项目详情中找到更多语法。

```jsx {1,4-6,11}
import React from 'react';

function MyComponent(props) {
  if (props.isBar) {
    return <div>Bar</div>;
  }

  return <div>Foo</div>;
}

export default MyComponent;
```

http://localhost:3000

import React from 'react';

function MyComponent(props) {
  if (props.isBar) {
    return <div>Bar</div>;
  }

  return <div>Foo</div>;
}

export default MyComponent;

偏好注释

尽可能使用注释高亮。通过在代码中内联高亮，当你的代码块变长时，你不必手动计算行数。如果你添加/删除行，你也不必偏移行范围。

- ```jsx {3}
+ ```jsx {4}
  function HighlightSomeText(highlight) {
    if (highlight) {
+     console.log('Highlighted text found');
      return 'This text is highlighted!';
    }

    return 'Nothing highlighted';
  }
  ```

下面，我们将介绍如何扩展魔法注释系统以定义自定义指令及其功能。仅当不存在高亮元字符串时，才会解析魔法注释。

自定义魔法注释

// highlight-next-line 和 // highlight-start 等被称为"魔法注释"，因为它们将被解析和删除，其目的是为下一行或由开始和结束注释对包围的部分添加元数据。

你可以通过主题配置声明自定义魔法注释。例如，你可以注册另一个魔法注释，添加 code-block-error-line 类名：

docusaurus.config.js
src/css/custom.css
myDoc.md

export default {
  themeConfig: {
    prism: {
      magicComments: [
        // 记得同时扩展默认高亮类名！
        {
          className: 'theme-code-block-highlighted-line',
          line: 'highlight-next-line',
          block: {start: 'highlight-start', end: 'highlight-end'},
        },
        {
          className: 'code-block-error-line',
          line: 'This will error',
        },
      ],
    },
  },
};

.code-block-error-line {
  background-color: #ff000020;
  display: block;
  margin: 0 calc(-1 * var(--ifm-pre-padding));
  padding: 0 var(--ifm-pre-padding);
  border-left: 3px solid #ff000080;
}

在 JavaScript 中，尝试访问 `null` 的属性将导致错误。

```js
const name = null;
// This will error
console.log(name.toUpperCase());
// Uncaught TypeError: Cannot read properties of null (reading 'toUpperCase')
```

http://localhost:3000

在 JavaScript 中，尝试访问 null 的属性将导致错误。

const name = null;
console.log(name.toUpperCase());
// Uncaught TypeError: Cannot read properties of null (reading 'toUpperCase')

如果在元字符串中使用数字范围（{1,3-4} 语法），Docusaurus 将应用第一个 magicComments 条目的类名。默认情况下，这是 theme-code-block-highlighted-line，但如果你更改 magicComments 配置并使用不同的第一个条目，元字符串范围的含义也会改变。

你可以通过 magicComments: [] 禁用默认行高亮注释。如果没有魔法注释配置，但 Docusaurus 遇到包含元字符串范围的代码块，它将出错，因为没有要应用的类名——高亮类名只是一个魔法注释条目。

每个魔法注释条目将包含三个键：className（必需）、line（应用于直接下一行），或 block（包含 start 和 end），应用于两个注释包围的整个块。

使用 CSS 定位类已经可以做很多事情，但你可以通过交换解锁这个特性的全部潜力。

npm
Yarn
pnpm
Bun

npm run swizzle @docusaurus/theme-classic CodeBlock/Line

yarn swizzle @docusaurus/theme-classic CodeBlock/Line

pnpm run swizzle @docusaurus/theme-classic CodeBlock/Line

bun run swizzle @docusaurus/theme-classic CodeBlock/Line

Line 组件将接收类名列表，基于此你可以有条件地渲染不同的标记。

行号

你可以通过在语言元字符串中使用 showLineNumbers 键来为代码块启用行号（不要忘记在键前直接添加空格）。

```jsx showLineNumbers
import React from 'react';

export default function MyComponent(props) {
  return <div>Foo</div>;
}
```

http://localhost:3000

import React from 'react';

export default function MyComponent(props) {
  return <div>Foo</div>;
}

默认情况下，计数器从第 1 行开始。可以传递自定义计数器起始值以分割大型代码块以提高可读性：

```jsx showLineNumbers=3
export default function MyComponent(props) {
  return <div>Foo</div>;
}
```

http://localhost:3000

export default function MyComponent(props) {
  return <div>Foo</div>;
}

交互式代码编辑器

（由 React Live 提供支持）

你可以使用 @docusaurus/theme-live-codeblock 插件创建交互式代码编辑器。首先，将插件添加到你的包中。

npm
Yarn
pnpm
Bun

npm install --save @docusaurus/theme-live-codeblock

yarn add @docusaurus/theme-live-codeblock

pnpm add @docusaurus/theme-live-codeblock

bun add @docusaurus/theme-live-codeblock

你还需要将插件添加到 docusaurus.config.js 中。

export default {
  // ...
  themes: ['@docusaurus/theme-live-codeblock'],
  // ...
};

要使用插件，请创建一个将 live 附加到语言元字符串的代码块。

```jsx live
function Clock(props) {
  const [date, setDate] = useState(new Date());
  useEffect(() => {
    const timerID = setInterval(() => tick(), 1000);

    return function cleanup() {
      clearInterval(timerID);
    };
  });

  function tick() {
    setDate(new Date());
  }

  return (
    <div>
      <h2>It is {date.toLocaleTimeString()}.</h2>
    </div>
  );
}
```

代码块将作为交互式编辑器呈现。对代码的更改将实时反映在结果面板上。

http://localhost:3000

实时编辑器

function Clock(props) {
  const [date, setDate] = useState(new Date());
  useEffect(() => {
    const timerID = setInterval(() => tick(), 1000);

    return function cleanup() {
      clearInterval(timerID);
    };
  });

  function tick() {
    setDate(new Date());
  }

  return (
    <div>
      <h2>It is {date.toLocaleTimeString()}.</h2>
    </div>
  );
}

结果

导入

react-live 和导入

无法直接从 react-live 代码编辑器导入组件，你必须预先定义可用的导入。

默认情况下，所有 React 导入都可用。如果你需要更多可用的导入，请交换 react-live 作用域：

npm
Yarn
pnpm
Bun

npm run swizzle @docusaurus/theme-live-codeblock ReactLiveScope -- --eject

yarn swizzle @docusaurus/theme-live-codeblock ReactLiveScope --eject

pnpm run swizzle @docusaurus/theme-live-codeblock ReactLiveScope --eject

bun run swizzle @docusaurus/theme-live-codeblock ReactLiveScope --eject

src/theme/ReactLiveScope/index.js
import React from 'react';

const ButtonExample = (props) => (
  <button
    {...props}
    style={{
      backgroundColor: 'white',
      color: 'black',
      border: 'solid red',
      borderRadius: 20,
      padding: 10,
      cursor: 'pointer',
      ...props.style,
    }}
  />
);

// 在此处添加 react-live 需要的导入
const ReactLiveScope = {
  React,
  ...React,
  ButtonExample,
};

export default ReactLiveScope;

现在 ButtonExample 组件可以使用：

http://localhost:3000

实时编辑器

function MyPlayground(props) {
  return (
    <div>
      <ButtonExample onClick={() => alert('hey!')}>Click me</ButtonExample>
    </div>
  );
}

结果

命令式渲染（noInline）

当你的代码跨越多个组件或变量时，应使用 noInline 选项以避免错误。

```jsx live noInline
const project = 'Docusaurus';

const Greeting = () => <p>Hello {project}!</p>;

render(<Greeting />);
```

与普通的交互式代码块不同，使用 noInline 时，React Live 不会将你的代码包装在内联函数中以渲染它。

你需要在代码末尾显式调用 render() 来显示输出。

http://localhost:3000

实时编辑器

const project = "Docusaurus";

const Greeting = () => (
  <p>Hello {project}!</p>
);

render(
  <Greeting />
);

结果

在代码块中使用 JSX 标记

Markdown 中的代码块始终将其内容保留为纯文本，这意味着你不能这样做：

type EditUrlFunction = (params: {
  // 这不会变成链接（出于合理原因！）
  version: <a href="/docs/versioning">Version</a>;
  versionDocsDirPath: string;
  docPath: string;
  permalink: string;
  locale: string;
}) => string | undefined;

如果你想嵌入 HTML 标记，如锚链接或粗体，可以使用 <pre> 标签、<code> 标签或 <CodeBlock> 组件。

<pre>
  <b>Input: </b>1 2 3 4{'\n'}
  <b>Output: </b>"366300745"{'\n'}
</pre>

http://localhost:3000

Input: 1 2 3 4
Output: "366300745"

MDX 对空白不敏感

MDX 遵循 JSX 行为：换行字符，即使在 <pre> 内，也会转换为空格。你必须显式写入换行符才能打印出来。

注意

语法高亮仅适用于纯字符串。Docusaurus 不会尝试解析包含 JSX 子元素的代码块内容。

多语言支持的代码块

使用 MDX，你可以轻松地在文档中创建交互式组件，例如，以多种编程语言显示代码并使用选项卡组件在它们之间切换。

我们没有实现专门的多语言支持代码块组件，而是在经典主题中实现了一个通用的 <Tabs> 组件，以便你也可以将其用于其他非代码场景。

下面是如何在文档中使用多语言代码选项卡的示例。请注意，每种语言块上方和下方的空行是有意的。这是 MDX 的当前限制：你必须在 Markdown 语法周围留出空行，以便 MDX 解析器知道这是 Markdown 语法而不是 JSX。

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="js" label="JavaScript">

```js
function helloWorld() {
  console.log('Hello, world!');
}
```

</TabItem>
<TabItem value="py" label="Python">

```py
def hello_world():
  print("Hello, world!")
```

</TabItem>
<TabItem value="java" label="Java">

```java
class HelloWorld {
  public static void main(String args[]) {
    System.out.println("Hello, World");
  }
}
```

</TabItem>
</Tabs>

你将得到以下结果：

http://localhost:3000

JavaScript
Python
Java

function helloWorld() {
  console.log('Hello, world!');
}

def hello_world():
  print("Hello, world!")

class HelloWorld {
  public static void main(String args[]) {
    System.out.println("Hello, World");
  }
}

如果你有多个多语言代码选项卡，并且希望在选项卡实例之间同步选择，请参考同步选项卡选择部分。

Docusaurus npm2yarn remark 插件

显示 CLI 命令的 npm 和 Yarn 版本是一个非常常见的需求，例如：

npm
Yarn
pnpm
Bun

npm install @docusaurus/remark-plugin-npm2yarn

yarn add @docusaurus/remark-plugin-npm2yarn

pnpm add @docusaurus/remark-plugin-npm2yarn

bun add @docusaurus/remark-plugin-npm2yarn

Docusaurus 开箱即用地提供了这样的实用工具，使你无需每次都使用 Tabs 组件。要启用此功能，首先安装 @docusaurus/remark-plugin-npm2yarn 包，然后在 docusaurus.config.js 中，对于需要此功能的插件（文档、博客、页面等），在 remarkPlugins 选项中注册它。（有关配置格式的更多详细信息，请参见文档配置）

docusaurus.config.js
export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          remarkPlugins: [
            [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
          ],
        },
        pages: {
          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
        },
        blog: {
          remarkPlugins: [
            [
              require('@docusaurus/remark-plugin-npm2yarn'),
              {converters: ['pnpm']},
            ],
          ],
          // ...
        },
      },
    ],
  ],
};

然后通过在代码块中添加 npm2yarn 键来使用它：

```bash npm2yarn
npm install @docusaurus/remark-plugin-npm2yarn
```

配置

选项	类型	默认值	描述
`sync`	`boolean`	`false`	是否在所有代码块之间同步选定的转换器。
`converters`	`array`	`'yarn'`、`'pnpm'`	要使用的转换器列表。转换器的顺序很重要，因为第一个转换器将用作默认选择。

在 JSX 中使用

在 Markdown 之外，你可以使用 @theme/CodeBlock 组件获得相同的输出。

import CodeBlock from '@theme/CodeBlock';

export default function MyReactPage() {
  return (
    <div>
      <CodeBlock
        language="jsx"
        title="/src/components/HelloCodeTitle.js"
        showLineNumbers>
        {`function HelloCodeTitle(props) {
  return <h1>Hello, {props.name}</h1>;
}`}
      </CodeBlock>
    </div>
  );
}

http://localhost:3000

/src/components/HelloCodeTitle.js
function HelloCodeTitle(props) {
return <h1>Hello, {props.name}</h1>;
}

接受的 props 是 language、title 和 showLineNumbers，与编写 Markdown 代码块的方式相同。

尽管不鼓励，但你也可以传入 metastring prop，如 metastring='{1-2} title="/src/components/HelloCodeTitle.js" showLineNumbers'，这是 Markdown 代码块在底层的处理方式。但是，我们建议你使用注释高亮行。

如之前所述，语法高亮仅在子元素是简单字符串时应用。

代码标题​

语法高亮​

主题​

支持的语言​

行高亮​

使用注释高亮​

使用元字符串高亮​

自定义魔法注释​

行号​

交互式代码编辑器​

导入​

命令式渲染（noInline）​

在代码块中使用 JSX 标记​

多语言支持的代码块​

Docusaurus npm2yarn remark 插件​

配置​

在 JSX 中使用​

代码标题

语法高亮

主题

支持的语言

行高亮

使用注释高亮

使用元字符串高亮

自定义魔法注释

行号

交互式代码编辑器

导入

命令式渲染（noInline）

在代码块中使用 JSX 标记

多语言支持的代码块

Docusaurus npm2yarn remark 插件

配置

在 JSX 中使用