# Headless Web SDK

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/getting-started/node](https://docs.univer.ai/zh-CN/guides/docs/getting-started/node)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/getting-started/node.md](https://docs.univer.ai/zh-CN/guides/docs/getting-started/node.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

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

---

Univer 具备同构特性，不仅可在浏览器端运行，还能在 Node.js 环境下使用。你可以基于 Headless Univer 开发数据处理服务，在服务器端生成或修改文档，并通过 Facade API 与 Univer Docs 进行交互。

> Interactive example: [Open the playground](/playground/docs/node-via-plugin)

Headless Univer 与浏览器端的使用方式类似，在预设模式下我们提供开箱即用的预设包；而在插件模式下，你仅需把涉及 UI 的插件排除即可。

### 预设模式

#### 安装

#### npm

```bash
npm install @univerjs/preset-docs-node-core
```

#### pnpm

```bash
pnpm add @univerjs/preset-docs-node-core
```

#### yarn

```bash
yarn add @univerjs/preset-docs-node-core
```

#### bun

```bash
bun add @univerjs/preset-docs-node-core
```

#### 使用

```typescript
import { UniverDocsNodeCorePreset } from '@univerjs/preset-docs-node-core' // [!code ++]
import docsNodeCoreZhCN from '@univerjs/preset-docs-node-core/locales/zh-CN' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

async function run(): Promise<void> {
  const { univer, univerAPI } = createUniver({
    locale: LocaleType.ZH_CN,
    locales: {
      [LocaleType.ZH_CN]: mergeLocales(
        docsNodeCoreZhCN, // [!code ++]
      ),
    },
    presets: [
      UniverDocsNodeCorePreset(), // [!code ++]
    ],
  })

  // 你可以在这里任意调用 Facade API 进行文档处理
}

run()
```

### 插件模式

#### 安装

#### npm

```bash
npm install @univerjs/core @univerjs/engine-render @univerjs/engine-formula @univerjs/docs
```

#### pnpm

```bash
pnpm add @univerjs/core @univerjs/engine-render @univerjs/engine-formula @univerjs/docs
```

#### yarn

```bash
yarn add @univerjs/core @univerjs/engine-render @univerjs/engine-formula @univerjs/docs
```

#### bun

```bash
bun add @univerjs/core @univerjs/engine-render @univerjs/engine-formula @univerjs/docs
```

#### 使用

```typescript
import { LocaleType, Univer, UniverInstanceType } from '@univerjs/core'
import { UniverDocsPlugin } from '@univerjs/docs'
import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'
import { UniverRenderEnginePlugin } from '@univerjs/engine-render'

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: {},
  },
})

univer.registerPlugin(UniverRenderEnginePlugin)
univer.registerPlugin(UniverFormulaEnginePlugin)
univer.registerPlugin(UniverDocsPlugin)

univer.createUnit(UniverInstanceType.UNIVER_DOC, {})
```
