mirror of
https://github.com/dream-num/univer.git
synced 2026-10-02 04:24:34 +08:00
docs: update readme (#711)
This commit is contained in:
Wenzhao Hu
+54
-85
@@ -1,117 +1,86 @@
|
||||
<!-- Logo here -->
|
||||
|
||||
# Univer
|
||||
|
||||
|
||||
|
||||
[](https://codecov.io/gh/dream-num/univer)
|
||||
[](https://www.codefactor.io/repository/github/dream-num/univer/overview/dev)
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
|
||||
简体中文 | [English](./README.md)
|
||||
|
||||
<!-- An introduction photo here. -->
|
||||
|
||||
> ⚠️ 该项目仍在开发中，请注意可能会有较大的 API 变更。欢迎向我们提交问题以及建议。
|
||||
|
||||
## 介绍
|
||||
|
||||
Univer 是一个开源的协作解决方案，旨在将协作能力赋能所有系统。 接入我们之后，用户可以同步在自己的系统中查看和编辑 Microsoft Office 文件，避免上传和下载 PPT、Word、Excel。
|
||||
Univer 是一套企业文档与数据协同解决方案，包括电子表格、文档和幻灯片三大文档类型，高可扩展性设计使得开发者可以在 Univer 的基础上定制个性化功能。
|
||||
|
||||
我们在本仓库中提供了 Univer 前端代码，一套基于 Canvas 的框架，用于构建文档、电子表格和幻灯片。
|
||||
Univer 的功能特性包括：
|
||||
|
||||
> ⚠️ 该项目仍在开发中
|
||||
- 📈 支持电子表格，后续还会支持文档和幻灯片
|
||||
- 🌌 高度可扩展的架构设计
|
||||
- 🔌 插件化架构，文档的能力可按需组合，支持自定义插件，方便二次开发
|
||||
- 💄 提供组件库和图标以帮助开发者呈现一致的用户体验
|
||||
- ⚡ 高性能
|
||||
- ✏️ 统一高效的渲染引擎和公式引擎，基于 Canvas
|
||||
- 🧮 高性能的公式引擎，支持 Web Worker
|
||||
- 🌍 国际化支持
|
||||
|
||||
## Demo
|
||||
## 使用
|
||||
|
||||
- [Univer Demo](https://dream-num.github.io/univer-demo/)
|
||||
我们建议通过将 Univer 作为 npm 包使用，请参考文档上的[快速开始]()小节。我们还准备了一个[在线 playground]()，你无需在本地安装 Univer 就可以体验使用 Univer 开发。
|
||||
|
||||
## Packages
|
||||
Univer 基于插件化架构设计，你可以安装以下包来增强 Univer 的功能。
|
||||
|
||||
| 包名 | 描述 | 版本 |
|
||||
| :------------------------------------------ | :---------- | :-------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [core](./packages/core) | - | [](https://npmjs.org/package/@univerjs/core) |
|
||||
| [design](./packages/design) | - | [](https://npmjs.org/package/@univerjs/design) |
|
||||
| [docs](./packages/docs) | - | [](https://npmjs.org/package/@univerjs/docs) |
|
||||
| [docs-ui](./packages/docs-ui) | - | [](https://npmjs.org/package/@univerjs/docs-ui) |
|
||||
| [engine-formula](./packages/engine-formula) | - | [](https://npmjs.org/package/@univerjs/engine-formula) |
|
||||
| [engine-numfmt](./packages/engine-numfmt) | - | [](https://npmjs.org/package/@univerjs/engine-numfmt) |
|
||||
| [engine-render](./packages/engine-render) | - | [](https://npmjs.org/package/@univerjs/engine-render) |
|
||||
| [rpc](./packages/rpc) | - | [](https://npmjs.org/package/@univerjs/rpc) |
|
||||
| [sheets](./packages/sheets) | - | [](https://npmjs.org/package/@univerjs/sheets) |
|
||||
| [sheets-formula](./packages/sheets-formula) | - | [](https://npmjs.org/package/@univerjs/sheets-formula) |
|
||||
| [sheets-numfmt](./packages/sheets-numfmt) | - | [](https://npmjs.org/package/@univerjs/sheets-numfmt) |
|
||||
| [sheets-ui](./packages/sheets-ui) | - | [](https://npmjs.org/package/@univerjs/sheets-ui) |
|
||||
| [ui](./packages/ui) | - | [](https://npmjs.org/package/@univerjs/ui) |
|
||||
| [uniscript](./packages/uniscript) | - | [](https://npmjs.org/package/@univerjs/uniscript) |
|
||||
### Packages
|
||||
|
||||
## 开发
|
||||
| 包名 | 描述 | 版本 |
|
||||
| :------------------------------------------- | :-------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [core](./packages/core) | Univer 核心包，实现 Univer 架构和插件机制、基础服务，以及各个文档类型的基本模型 | [](https://npmjs.org/package/@univerjs/core) |
|
||||
| [design](./packages/design) | 实现 Univer 设计语言，提供了一套 CSS 以及一套基于 React 的组件 | [](https://npmjs.org/package/@univerjs/design) |
|
||||
| [docs](./packages/docs) | 实现了富文本文档的基本业务，同时支持其他业务的文本编辑 | [](https://npmjs.org/package/@univerjs/docs) |
|
||||
| [docs-ui](./packages/docs-ui) | 实现了富文本文档的用户交互 | [](https://npmjs.org/package/@univerjs/docs-ui) |
|
||||
| [engine-formula](./packages/engine-formula) | 实现公式引擎 | [](https://npmjs.org/package/@univerjs/engine-formula) |
|
||||
| [engine-numfmt](./packages/engine-numfmt) | 实现数字格式引擎 | [](https://npmjs.org/package/@univerjs/engine-numfmt) |
|
||||
| [engine-render](./packages/engine-render) | 实现渲染引擎 | [](https://npmjs.org/package/@univerjs/engine-render) |
|
||||
| [rpc](./packages/rpc) | 实现 RPC 机制，以及在主从文档副本之间同步数据的方法，方便 web worker 等跨线程场景的开发 | [](https://npmjs.org/package/@univerjs/rpc) |
|
||||
| [sheets](./packages/sheets) | 实现电子表格的基本业务 | [](https://npmjs.org/package/@univerjs/sheets) |
|
||||
| [sheets-formula](./packages/sheets-formula) | 实现电子表格的公式编辑 | [](https://npmjs.org/package/@univerjs/sheets-formula) |
|
||||
| [sheets-numfmt](./packages/sheets-numfmt) | 实现电子表格中的数字格式编辑 | [](https://npmjs.org/package/@univerjs/sheets-numfmt) |
|
||||
| [sheets-ui](./packages/sheets-ui) | 实现电子表格的用户交互 | [](https://npmjs.org/package/@univerjs/sheets-ui) |
|
||||
| [ui](./packages/ui) | 实现基本的用户交互服务，并基于 React 提供了一套桌面端的交互布局 | [](https://npmjs.org/package/@univerjs/ui) |
|
||||
| [uniscript](./packages/uniscript) （实验性） | 一套基于 TypeScript 的 DSL，让用户可以通过脚本语言操纵 Univer 完成更复杂的任务 | [](https://npmjs.org/package/@univerjs/uniscript) |
|
||||
|
||||
### 环境
|
||||
## 贡献
|
||||
|
||||
- [node.js](https://nodejs.org) version 16.20.0
|
||||
- [pnpm](https://pnpm.io) version 8.6.2
|
||||
我们欢迎各种形式的贡献，你可以向我们提交[问题或功能请求](https://github.com/dream-num/univer/issues)。请先阅读我们的[贡献指南](./CONTRIBUTING.md)。
|
||||
|
||||
### 安装
|
||||
|
||||
```
|
||||
git clone http://github.com/dream-num/univer
|
||||
cd univer
|
||||
npm i -g pnpm # MacOS : sudo npm i -g pnpm
|
||||
pnpm i
|
||||
```
|
||||
|
||||
### 开发
|
||||
|
||||
启动全部
|
||||
|
||||
```shell
|
||||
npm run dev
|
||||
```
|
||||
|
||||
启动 sheets
|
||||
|
||||
```shell
|
||||
npm run dev:sheet
|
||||
```
|
||||
|
||||
启动 docs
|
||||
|
||||
```shell
|
||||
npm run dev:doc
|
||||
```
|
||||
|
||||
启动 slides
|
||||
|
||||
```shell
|
||||
npm run dev:slide
|
||||
```
|
||||
|
||||
## 社区
|
||||
|
||||
欢迎加入我们的 [Discord 社区](https://discord.gg/z3NKNT6D2f)。
|
||||
|
||||
## 问题反馈
|
||||
|
||||
请到 [Issues](http://github.com/dream-num/univer/issues) 提交问题。
|
||||
如果你想要提交代码，也请先阅读贡献指南，它会指导你如何在本地搭建开发环境以及提交 pull request。
|
||||
|
||||
## 关注者
|
||||
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
|
||||
## 整体架构
|
||||
## 链接
|
||||
|
||||
Univer 采用 typescript 编写，按照插件化架构进行设计，核心外的功能都以插件的形式进行开发，今后会建设插件市场，满足更加个性化的需求
|
||||
|
||||
- [文档]()
|
||||
- [在线 Playground]()
|
||||
- [官方网站]()
|
||||
- [Legacy Univer Demo](https://dream-num.github.io/univer-demo/)
|
||||
|
||||
## 渲染引擎
|
||||
### 社区
|
||||
|
||||
Univer sheet, document, slide 采用同一套渲染引擎架构，把应用抽象为文本流，表格，画布，core 部分触发渲染，object 为渲染器。
|
||||
|
||||
- [Discord 社区](https://discord.gg/XPGnMBmpd6)
|
||||
- [Github Discussions](https://github.com/dream-num/univer/discussions)
|
||||
- 加入 Univer 中文社群
|
||||
|
||||
1. 做到了应用互相间的嵌套和操作。
|
||||
2. sheet 单元格支持嵌入 doc 文字
|
||||
3. slide 中支持插入 sheet，doc，slide
|
||||
## 授权
|
||||
|
||||
| slide 10-layer embedding | Sheet in slide and doc in cell | wrap text around a picture |
|
||||
| :-------------------------------: | :--------------------------------------------: | :-----------------------------: |
|
||||
|  |  |  |
|
||||
Univer 基于 Apache-2.0 协议分发。
|
||||
|
||||
## 公式引擎
|
||||
---
|
||||
|
||||
Univer 自研公式引擎，支持异步计算, lambda 函数及范围命名
|
||||
|
||||
|
||||
上海梦数科技有限公司 2023 版权所有
|
||||
|
||||
@@ -10,72 +10,74 @@
|
||||
|
||||
English | [简体中文](./README-zh.md)
|
||||
|
||||
<!-- A introduction photo here. -->
|
||||
<!-- An introduction photo here. -->
|
||||
|
||||
> ⚠️ This project is still in heavy development.
|
||||
> ⚠️ This project is still in heavy development. Please note that there are likely to be major API changes. Please submit issues and suggestions to us.
|
||||
|
||||
## Introduction
|
||||
|
||||
Univer is a set of enterprise document and data collaboration solutions, including spreadsheets, documents, and slides. The highly extensible design allows developers to customize personalized functions based on Univer.
|
||||
|
||||
- 📈 Univer supports spreadsheets. Documents and slides will be supported in the future
|
||||
- 🌌 Highly extensible architecture design
|
||||
- 🔌 Plug-in architecture, the capabilities of documents can be combined on demand, support third-party plug-ins, and facilitate customization development
|
||||
- 💄 Provide component library and icons to help developers present a consistent user experience
|
||||
- ⚡ High performance
|
||||
- ✏️ Unified and efficient rendering engine and formula engine, based on Canvas
|
||||
- 🧮 High-performance formula engine, supports Web Worker
|
||||
- 🌍 Internationalization support
|
||||
Highlights of Univer:
|
||||
|
||||
## Links
|
||||
- 📈 Univer supports spreadsheets. Documents and slides will be supported in the future.
|
||||
- 🌌 Highly extensible architecture design.
|
||||
- 🔌 Plug-in architecture, the capabilities of documents can be combined on demand, support third-party plug-ins, and facilitate customization development.
|
||||
- 💄 Provide component library and icons to help developers present a consistent user experience.
|
||||
- ⚡ High performance.
|
||||
- ✏️ Unified and efficient rendering engine and formula engine, based on Canvas.
|
||||
- 🧮 High-performance formula engine, supports Web Worker.
|
||||
- 🌍 Internationalization support.
|
||||
|
||||
- [Online Playground]()
|
||||
- [Documentation]()
|
||||
- [Official Website]()
|
||||
- [Legacy Univer Demo](https://dream-num.github.io/univer-demo/)
|
||||
## Usage
|
||||
|
||||
## Packages
|
||||
We recommend to import Univer as a npm package. Please checkout the [Quick Start]() section on the documentation website. We also have an [online playground]() which can help you preview Univer without setting up the development environment.
|
||||
|
||||
| Name | Description | Version |
|
||||
| :------------------------------------------ | :---------- | :-------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [core](./packages/core) | - | [](https://npmjs.org/package/@univerjs/core) |
|
||||
| [design](./packages/design) | - | [](https://npmjs.org/package/@univerjs/design) |
|
||||
| [docs](./packages/docs) | - | [](https://npmjs.org/package/@univerjs/docs) |
|
||||
| [docs-ui](./packages/docs-ui) | - | [](https://npmjs.org/package/@univerjs/docs-ui) |
|
||||
| [engine-formula](./packages/engine-formula) | - | [](https://npmjs.org/package/@univerjs/engine-formula) |
|
||||
| [engine-numfmt](./packages/engine-numfmt) | - | [](https://npmjs.org/package/@univerjs/engine-numfmt) |
|
||||
| [engine-render](./packages/engine-render) | - | [](https://npmjs.org/package/@univerjs/engine-render) |
|
||||
| [rpc](./packages/rpc) | - | [](https://npmjs.org/package/@univerjs/rpc) |
|
||||
| [sheets](./packages/sheets) | - | [](https://npmjs.org/package/@univerjs/sheets) |
|
||||
| [sheets-formula](./packages/sheets-formula) | - | [](https://npmjs.org/package/@univerjs/sheets-formula) |
|
||||
| [sheets-numfmt](./packages/sheets-numfmt) | - | [](https://npmjs.org/package/@univerjs/sheets-numfmt) |
|
||||
| [sheets-ui](./packages/sheets-ui) | - | [](https://npmjs.org/package/@univerjs/sheets-ui) |
|
||||
| [ui](./packages/ui) | - | [](https://npmjs.org/package/@univerjs/ui) |
|
||||
| [uniscript](./packages/uniscript) | - | [](https://npmjs.org/package/@univerjs/uniscript) |
|
||||
Univer bases on a plugin architecture. You can install the following packages to enhance the functionality of Univer.
|
||||
|
||||
### Packages
|
||||
|
||||
| Name | Description | Version |
|
||||
| :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [core](./packages/core) | Implements plugin system and architecture of Univer. It also provides basic services and models of different types of documents. | [](https://npmjs.org/package/@univerjs/core) |
|
||||
| [design](./packages/design) | Implements the design system on Univer. It provides CSS and a component kit based on React. | [](https://npmjs.org/package/@univerjs/design) |
|
||||
| [docs](./packages/docs) | Implements basic logics of rich text editing features. It also facilitates text editing in other types of documents. | [](https://npmjs.org/package/@univerjs/docs) |
|
||||
| [docs-ui](./packages/docs-ui) | Provides user interface of Univer Documents | [](https://npmjs.org/package/@univerjs/docs-ui) |
|
||||
| [engine-formula](./packages/engine-formula) | It implements a rendering engine based on Canvas and is extensible for | [](https://npmjs.org/package/@univerjs/engine-formula) |
|
||||
| [engine-numfmt](./packages/engine-numfmt) | It implements a number format engine. | [](https://npmjs.org/package/@univerjs/engine-numfmt) |
|
||||
| [engine-render](./packages/engine-render) | It implements a rendering engine based on canvas context2d. | [](https://npmjs.org/package/@univerjs/engine-render) |
|
||||
| [rpc](./packages/rpc) | It implements a RPC mechanism and methods to sync data between different replicas of Univer documents. | [](https://npmjs.org/package/@univerjs/rpc) |
|
||||
| [sheets](./packages/sheets) | Basic logics of spreadsheet features. | [](https://npmjs.org/package/@univerjs/sheets) |
|
||||
| [sheets-formula](./packages/sheets-formula) | It implements formula in spreadsheets. | [](https://npmjs.org/package/@univerjs/sheets-formula) |
|
||||
| [sheets-numfmt](./packages/sheets-numfmt) | It implements number format in spreadsheets. | [](https://npmjs.org/package/@univerjs/sheets-numfmt) |
|
||||
| [sheets-ui](./packages/sheets-ui) | Provides user interface of Univer Spreadsheets | [](https://npmjs.org/package/@univerjs/sheets-ui) |
|
||||
| [ui](./packages/ui) | Implements basic user interactions with Univer and workbench layout based on React. | [](https://npmjs.org/package/@univerjs/ui) |
|
||||
| [uniscript](./packages/uniscript) (experimental) | Implements a DSL based on Typescript that empowers users to accomplish more sophisticated tasks | [](https://npmjs.org/package/@univerjs/uniscript) |
|
||||
|
||||
## Contribution
|
||||
|
||||
Please refer to [Contribution Guide](./CONTRIBUTING.md).
|
||||
We appreciate any kinds of contributing. You can submit [issues or feature requests](https://github.com/dream-num/univer/issues) to us. Please read our [contributing guide](./CONTRIBUTING.md) first.
|
||||
|
||||
## Community
|
||||
If you would like to contribute code to Univer, please refer to the contributing guide as well. It would guide you through the process of setting up the development environment and submitting a pull request.
|
||||
|
||||
Welcome to join our [Discord community](https://discord.gg/z3NKNT6D2f).
|
||||
## Stargazers
|
||||
|
||||
## Issues
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
|
||||
Please file an issue at [Issues](http://github.com/dream-num/univer/issues).
|
||||
## Links
|
||||
|
||||
## Architecture
|
||||
- [Documentation]()
|
||||
- [Online Playground]()
|
||||
- [Official Website]()
|
||||
- [Legacy Univer Demo](https://dream-num.github.io/univer-demo/)
|
||||
|
||||
Univer is written in typescript and designed according to the plugin architecture. The functions outside the core are developed in the form of plugins.
|
||||
### Community
|
||||
|
||||
## Rendering engine
|
||||
- [Discord community](https://discord.gg/z3NKNT6D2f)
|
||||
|
||||
Univer sheet, document, and slide adopt the same rendering engine architecture, which abstracts the application into text flow, table, canvas, and core part triggers rendering, and object is the renderer.
|
||||
## License
|
||||
|
||||
## Formula engine
|
||||
|
||||
Univer formula engine, supports asynchronous calculation, lambda function and range naming
|
||||
Univer is distributed under the terms of the Apache-2.0 license.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -6,7 +6,6 @@ sidebar_position: 1
|
||||
|
||||
TODO: Logo Here
|
||||
|
||||
|
||||
Univer 是一套企业文档与数据协同解决方案，包括电子表格、文档和幻灯片三大文档类型，高可扩展性设计使得开发者可以在 Univer 的基础上定制个性化功能。
|
||||
|
||||
## 特性
|
||||
|
||||
@@ -6,7 +6,7 @@ sidebar_position: 1
|
||||
|
||||
[](https://badge.fury.io/js/@univerjs%2Fcore)
|
||||
|
||||
@univerjs/core 是 Univer 的核心仓库，它提供的基础能力包括：
|
||||
@univerjs/core 是 Univer 的核心包，它提供的基础能力包括：
|
||||
|
||||
- 提供作为应用入口和其他 plugin 挂载点的 `Univer` 类型，以及管理不同类型文档的 `UniverDoc` 和 `UniverSheet` 类型
|
||||
- 各个类型文档的基本模型
|
||||
|
||||
Reference in New Issue
Block a user