# 代码块

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/features/code](https://docs.univer.ai/zh-CN/guides/docs/features/code)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/features/code.md](https://docs.univer.ai/zh-CN/guides/docs/features/code.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/code.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/code.zh-CN.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-code",
      "facade": "@univerjs-pro/docs-code/facade"
    },
    {
      "client": "@univerjs-pro/docs-code-ui",
      "locale": "@univerjs-pro/docs-code-ui/locale/zh-CN",
      "style": "@univerjs-pro/docs-code-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

代码块功能允许您在文档中插入和显示格式化的代码片段，并通过 Prism.js 实现语法高亮。

## 介绍

在 Univer Docs 中，代码块使您能够：

* **插入代码片段**：在文档的任何位置添加格式化的代码块。
* **语法高亮**：根据编程语言自动高亮代码。
* **退出和取消**：轻松从空段落退出或取消代码格式。

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs-pro/docs-code @univerjs-pro/docs-code-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-code @univerjs-pro/docs-code-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-code @univerjs-pro/docs-code-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-code @univerjs-pro/docs-code-ui
```

### 使用

```typescript
import { UniverDocsCodePlugin } from '@univerjs-pro/docs-code' // [!code ++]
import { UniverDocsCodeUIPlugin } from '@univerjs-pro/docs-code-ui' // [!code ++]
import DocsCodeUIZhCN from '@univerjs-pro/docs-code-ui/locale/zh-CN' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/docs-code-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DocsCodeUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsCodePlugin) // [!code ++]
univer.registerPlugin(UniverDocsCodeUIPlugin) // [!code ++]
```

如果您拥有 Univer 商业许可证，请参阅[在客户端使用许可证](https://docs.univer.ai/zh-CN/guides/license.md#in-plugin-mode)进行配置。

## Facade API

使用 API 前请确保已导入 facade：

```typescript
import '@univerjs-pro/docs-code/facade'
```

### 获取所有代码块

```typescript
const doc = univerAPI.getActiveDocument()
const codes = doc?.getCodes() ?? []
```

### 插入代码块

```typescript
const doc = univerAPI.getActiveDocument()
const code = doc?.insertCode({
  startOffset: 12,
  endOffset: 35,
})
```

### 退出代码块

```typescript
const doc = univerAPI.getActiveDocument()
doc?.exitCode()
```

### 取消空代码段落

```typescript
const doc = univerAPI.getActiveDocument()
doc?.cancelEmptyCodeParagraph()
```