README.md

Univer Documentation

This is the official documentation site for Univer, built with Next.js and Fumadocs.

Prerequisites

• Node.js >= 20.9
• pnpm >= 10

Local Development

Install dependencies:

pnpm install

Start the development server:

pnpm dev

The site will be available at http://localhost:3030.

Build for production:

pnpm build

Project Structure

├── app/              # Next.js application routes and layouts
├── components/       # React components for the documentation site
├── content/          # Documentation content (MDX)
│   ├── blog/         # Blog posts
│   ├── guides/       # User guides (docs, sheets, slides, pro, recipes, skills)
│   ├── icons/        # Icons reference
│   └── reference/    # API reference
├── examples/         # Framework integration examples (React, Vue, Angular, Astro)
├── lib/              # Utility libraries
├── public/           # Static assets
└── scripts/          # Build and automation scripts

Contributing

We welcome contributions to the documentation. Please ensure your changes follow the existing style and conventions. Run pnpm lint and pnpm typecheck before submitting.

For more information about contributing to Univer, see the main repository.