# 程式碼區塊

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

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

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

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

---

#### Package metadata

```json
{
  "mobile": true,
  "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-TW",
      "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 DocsCodeUIZhTW from '@univerjs-pro/docs-code-ui/locale/zh-TW' // [!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_TW,
  locales: {
    [LocaleType.ZH_TW]: mergeLocales(
      DocsCodeUIZhTW, // [!code ++]
    ),
  },
})

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

如果您擁有 Univer 商業授權，請參閱[在用戶端使用授權](https://docs.univer.ai/zh-TW/server/license.md#in-plugin-mode)進行配置。

## 行動裝置支援

先設定[行動版編輯器](https://docs.univer.ai/zh-TW/guides/docs/getting-started/installation.md#mobile-support)。在本頁外掛模式的初始化程式碼中，將下列桌面版註冊替換為同一套件匯出的行動版外掛，並在**開啟文件前**完成。保留模型外掛、樣式、語言套件與 Facade 匯入，請勿同時註冊兩個版本。

| 套件                           | 桌面版註冊                    | 行動版註冊                          |
| ---------------------------- | ------------------------ | ------------------------------ |
| `@univerjs-pro/docs-code-ui` | `UniverDocsCodeUIPlugin` | `UniverDocsCodeMobileUIPlugin` |

## 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()
```