# @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)