Univer Docs

This is the repo for univer.ai. This repo contains the source code for the official website, as well as the documentation for the Univer API, blog posts, and other resources.

简体中文 | English | 日本語

Contributing

Please feel free to contribute to this repo by submitting a pull request. If you have any questions, please contact us at developer@univer.ai.

The documentation is built using Astro and Typedoc. Before you begin contributing, please make sure you are familiar with the usage of these two tools.

Contribute PRs by Developing Locally

To begin contributing, fork this repo and clone it to your local machine.

# Clone the forked repo
git clone git@github.com:<YOUR_USERNAME>/<REPO_NAME>.git

Before you begin, please make sure your development environment meets the following requirements:

• node.js >= 18.0.0
• pnpm >= 8.0.0

After confirming that your development environment meets the above requirements, you can execute the following command to start developing:

# Install dependencies
pnpm i

# Start the development server
pnpm dev

# Build the website
pnpm build

# If you want to update the api docs, please execute `pnpm up univer` to update the univer version.
pnpm up

Contribute PRs using an online code editor

If you don't want to install the development environment locally, or your local environment doesn't meet the development requirements, you can use an online code editor to develop.

You can click the following button to open this repo in StackBlitz:

Graphs

Graphs help users to understand your ideas better. To keep styles of graphs consistent, we use Excalidraw to create graphs. We store the source files of graphs in this repo directly. It is recommend to install Excalidraw VSCode extension and use it to edit the source files.