# @univerjs/docs

> Core document model and rich-text operations for Univer Docs.

Latest version **1.0.2** (published 2026-09-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @univerjs/docs
pnpm add @univerjs/docs
yarn add @univerjs/docs
bun add @univerjs/docs
```

## Health

**Score 80/100 (A)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2026-09-24 |
| First published | 2023-12-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 14411 |
| Author | DreamNum Co., Ltd. <developer@univer.ai> |
| Maintainers | jikkai, wbfsa, mengshukeji |
| Keywords | univer, docs, document, rich-text, plugin |

## Links

- npm: https://www.npmjs.com/package/@univerjs/docs
- Repository: https://github.com/dream-num/univer
- Homepage: https://univer.ai
- Issues: https://github.com/dream-num/univer/issues
- Funding: https://opencollective.com/univer
- npm.io page: https://npm.io/package/@univerjs/docs

## Dependencies (4)

- [@univerjs/rpc](https://npm.io/package/@univerjs/rpc.md) 1.0.2
- [@univerjs/core](https://npm.io/package/@univerjs/core.md) 1.0.2
- [@univerjs/protocol](https://npm.io/package/@univerjs/protocol.md) 1.0.2
- [@univerjs/engine-render](https://npm.io/package/@univerjs/engine-render.md) 1.0.2

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2026-09-24
- 1.0.0-rc.0 (rc) — 2026-09-10
- 1.0.0-beta.2 (beta) — 2026-08-22
- 1.0.0-insiders.20260813-7c9aa50 (insiders) — 2026-08-13
- 1.0.0-alpha.8 (alpha) — 2026-07-29
- 0.12.4-experimental.20251211-e01e32a (experimental) — 2025-12-11
- 0.12.3-nightly.202512060617 (nightly) — 2025-12-06
- 1.0.1 — 2026-09-24
- 1.0.0 — 2026-09-23
- 0.25.2 — 2026-09-17
- 1.0.0-beta.1 — 2026-08-15
- 1.0.0-insiders.20260809-70eefdd — 2026-08-09
- 1.0.0-insiders.20260808-70eefdd — 2026-08-08
- 1.0.0-beta.0 — 2026-08-05
- 1.0.0-insiders.20260805-b15e7f3 — 2026-08-05
- … 716 more at https://npm.io/package/@univerjs/docs/versions

## README

# @univerjs/docs

[![npm version](https://img.shields.io/npm/v/@univerjs/docs?style=flat-square)](https://npmjs.com/package/@univerjs/docs)
[![license](https://img.shields.io/npm/l/@univerjs/docs?style=flat-square)](https://npmjs.com/package/@univerjs/docs)
[![downloads](https://img.shields.io/npm/dm/@univerjs/docs?style=flat-square)](https://npmjs.com/package/@univerjs/docs)

`@univerjs/docs` provides the document data model and core rich-text operations for Univer Docs, independent of the UI layer.

## Package Overview

| Package | UMD global | CSS | Locales | Facade entry |
| --- | --- | :---: | :---: | :---: |
| `@univerjs/docs` | `UniverDocs` | No | No | Yes |

## Installation

```sh
pnpm add @univerjs/docs
# or
npm install @univerjs/docs
```

Keep all `@univerjs/*` packages on the same version.

## Usage

```ts
import { UniverDocsPlugin } from '@univerjs/docs';

univer.registerPlugin(UniverDocsPlugin);
```

## Resources

- [Documentation](https://docs.univer.ai)
- [NPM package](https://npmjs.com/package/@univerjs/docs)
- [GitHub repository](https://github.com/dream-num/univer)

---
_Source: https://npm.io/package/@univerjs/docs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._