@univerjs/preset-docs-collaboration 0.21.1 → 0.22.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # @univerjs/preset-docs-collaboration
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs/preset-docs-collaboration?style=flat-square)](https://npmjs.com/package/@univerjs/preset-docs-collaboration)
4
+ [![license](https://img.shields.io/npm/l/@univerjs/preset-docs-collaboration?style=flat-square)](https://npmjs.com/package/@univerjs/preset-docs-collaboration)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs/preset-docs-collaboration?style=flat-square)](https://npmjs.com/package/@univerjs/preset-docs-collaboration)
6
+
7
+ `@univerjs/preset-docs-collaboration` provides a preset for real-time collaboration in Univer Docs.
8
+
9
+ ## Package Overview
10
+
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | ------------------------------------- | ------------------------------- | :-: | :-----: | :----------: |
13
+ | `@univerjs/preset-docs-collaboration` | `UniverDocsCollaborationPreset` | Yes | Yes | Yes |
14
+
15
+ ## Installation
16
+
17
+ ```sh
18
+ pnpm add @univerjs/preset-docs-collaboration
19
+ # or
20
+ npm install @univerjs/preset-docs-collaboration
21
+ ```
22
+
23
+ Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
24
+
25
+ ## Usage
26
+
27
+ ```ts
28
+ import { UniverDocsCollaborationPreset } from '@univerjs/preset-docs-collaboration';
29
+
30
+ // Use with createUniver:
31
+ // createUniver({ presets: [UniverDocsCollaborationPreset()] });
32
+ ```
33
+
34
+ ## Resources
35
+
36
+ - [Documentation](https://docs.univer.ai)
37
+ - [NPM package](https://npmjs.com/package/@univerjs/preset-docs-collaboration)
38
+ - [GitHub repository](https://github.com/dream-num/univer)