Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,52 @@
# Univer Documentation

This is the official documentation site for [Univer](https://github.com/dream-num/univer), built with [Next.js](https://nextjs.org/) and [Fumadocs](https://fumadocs.vercel.app/).

## Prerequisites

- [Node.js](https://nodejs.org/) >= 20.9
- [pnpm](https://pnpm.io/) >= 10

## Local Development

Install dependencies:

```bash
pnpm install
```

Start the development server:

```bash
pnpm dev
```

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

Build for production:

```bash
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](https://github.com/dream-num/univer).
4 changes: 2 additions & 2 deletions content/guides/docs/features/core/index.ja-JP.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ interface CreateUniverParameter {
}
```

参考:[`createUniver`](/reference/methods/create-univer)
参考:[`createUniver`(https://docs.univer.ai/reference/methods/create-univer)

#### @univerjs/preset-docs-core

Expand Down Expand Up @@ -159,7 +159,7 @@ UniverSheetsCorePreset({

ここでの `'sheet.command.set-range-bold'` と `'sheet.command.set-range-italic'` はコマンド名で、該当メニュー項目を指します。

参考:[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core)
参考:[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core)

## プラグインモード

Expand Down
16 changes: 8 additions & 8 deletions content/guides/docs/features/core/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ interface CreateUniverParameter {
}
```

Reference: [`createUniver`](/reference/methods/create-univer)
Reference: [`createUniver`(https://docs.univer.ai/reference/methods/create-univer)

#### @univerjs/preset-docs-core

Expand Down Expand Up @@ -159,7 +159,7 @@ UniverSheetsCorePreset({

Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items.

Reference: [@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core)
Reference: [@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core)

## Plugin Mode

Expand Down Expand Up @@ -231,19 +231,19 @@ interface UniverParameter {
}
```

Reference: [`Univer`](/reference/classes/univer)
Reference: [`Univer`(https://docs.univer.ai/reference/classes/univer)

#### @univerjs/engine-render

This plugin is the rendering engine of Univer, responsible for rendering, scrollbars, cursor, and selection rendering. It provides the `UniverRenderEnginePlugin`.

Reference: [@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render)
Reference: [@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render)

#### @univerjs/engine-formula

This plugin is the formula engine of Univer, responsible for calculating and processing formulas. It provides the `UniverFormulaEnginePlugin`.

Reference: [@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula)
Reference: [@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula)

#### @univerjs/design

Expand Down Expand Up @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, {

Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items.

Reference: [@univerjs/ui](/reference/packages/plugins/univerjs/ui)
Reference: [@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui)

#### @univerjs/docs

This plugin is the core plugin of Univer Docs. It provides the `UniverDocsPlugin`.

Reference: [@univerjs/docs](/reference/packages/plugins/univerjs/docs)
Reference: [@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs)

#### @univerjs/docs-ui

This plugin is the UI plugin of Univer Docs, which includes UI components and interactions for the document editor. It provides the `UniverDocsUIPlugin`.

Reference: [@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui)
Reference: [@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui)
16 changes: 8 additions & 8 deletions content/guides/docs/features/core/index.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ interface CreateUniverParameter {
}
```

参考:[`createUniver`](/reference/methods/create-univer)
参考:[`createUniver`(https://docs.univer.ai/reference/methods/create-univer)

#### @univerjs/preset-docs-core

Expand Down Expand Up @@ -159,7 +159,7 @@ UniverDocsCorePreset({

这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称,表示对应的菜单项。

参考:[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core)
参考:[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core)

## 插件模式

Expand Down Expand Up @@ -231,19 +231,19 @@ interface UniverParameter {
}
```

参考:[`Univer`](/reference/classes/univer)
参考:[`Univer`(https://docs.univer.ai/reference/classes/univer)

#### @univerjs/engine-render

本插件是 Univer 的渲染引擎,负责渲染、滚动条、光标和选区等的绘制。其提供了 `UniverRenderEnginePlugin` 插件。

参考:[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render)
参考:[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render)

#### @univerjs/engine-formula

本插件是 Univer 的公式引擎,负责公式的计算和处理。其提供了 `UniverFormulaEnginePlugin` 插件。

参考:[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula)
参考:[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula)

#### @univerjs/design

Expand Down Expand Up @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, {

这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称,表示对应的菜单项。

参考:[@univerjs/ui](/reference/packages/plugins/univerjs/ui)
参考:[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui)

#### @univerjs/docs

本插件是 Univer Docs 的核心插件。其提供了 `UniverDocsPlugin` 插件。

参考:[@univerjs/docs](/reference/packages/plugins/univerjs/docs)
参考:[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs)

#### @univerjs/docs-ui

本插件是 Univer Docs 的 UI 插件,包含了文档编辑器的 UI 组件和交互。其提供了 `UniverDocsUIPlugin` 插件。

参考:[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui)
参考:[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui)
16 changes: 8 additions & 8 deletions content/guides/docs/features/core/index.zh-TW.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ interface CreateUniverParameter {
}
```

參考:[`createUniver`](/reference/methods/create-univer)
參考:[`createUniver`(https://docs.univer.ai/reference/methods/create-univer)

#### @univerjs/preset-docs-core

Expand Down Expand Up @@ -159,7 +159,7 @@ UniverDocsCorePreset({

這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱,表示對應的菜單項。

參考:[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core)
參考:[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core)

## 外掛模式

Expand Down Expand Up @@ -231,19 +231,19 @@ interface UniverParameter {
}
```

參考:[`Univer`](/reference/classes/univer)
參考:[`Univer`(https://docs.univer.ai/reference/classes/univer)

#### @univerjs/engine-render

本外掛是 Univer 的渲染引擎,負責渲染、滾動條、游標和選區等的繪製。其提供了 `UniverRenderEnginePlugin` 外掛。

參考:[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render)
參考:[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render)

#### @univerjs/engine-formula

本外掛是 Univer 的公式引擎,負責公式的計算和處理。其提供了 `UniverFormulaEnginePlugin` 外掛。

參考:[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula)
參考:[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula)

#### @univerjs/design

Expand Down Expand Up @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, {

這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱,表示對應的菜單項。

參考:[@univerjs/ui](/reference/packages/plugins/univerjs/ui)
參考:[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui)

#### @univerjs/docs

本外掛是 Univer Docs 的核心外掛。其提供了 `UniverDocsPlugin` 外掛。

參考:[@univerjs/docs](/reference/packages/plugins/univerjs/docs)
參考:[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs)

#### @univerjs/docs-ui

本外掛是 Univer Docs 的 UI 外掛,包含了文件編輯器的 UI 組件和交互。其提供了 `UniverDocsUIPlugin` 外掛。

參考:[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui)
參考:[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui)
2 changes: 1 addition & 1 deletion content/guides/docs/features/import-export.ja-JP.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ url.searchParams.set('unit', unitId)
url.searchParams.set('type', '1') // 1 は UniverInstanceType.UNIVER_DOC を表す
window.location.href = url.toString()

// または API: univerAPI.loadServerUnit(unitId, 1) を呼び出す。パラメータは https://reference.univer.ai/en-US/classes/FUniver#loadserverunit を参照
// または API: univerAPI.loadServerUnit(unitId, 1) を呼び出す。パラメータは /reference/facade/univer#loadserverunit を参照
```

#### `.docx` をインポートして `IDocumentData` を取得
Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ url.searchParams.set('unit', unitId)
url.searchParams.set('type', '1') // The meaning of 1 is UniverInstanceType.UNIVER_DOC
window.location.href = url.toString()

// Or call the API: univerAPI.loadServerUnit(unitId, 1) to load the document, refer to https://reference.univer.ai/en-US/classes/FUniver#loadserverunit for specific parameters
// Or call the API: univerAPI.loadServerUnit(unitId, 1) to load the document, refer to /reference/facade/univer#loadserverunit for specific parameters
```

#### Import `.docx` file and get `IDocumentData`
Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/import-export.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ url.searchParams.set('unit', unitId)
url.searchParams.set('type', '1') // 1 的意思是 String(UniverInstanceType.UNIVER_DOC)
window.location.href = url.toString()

// 或者调用API: univerAPI.loadServerUnit(unitId, 1) 加载文档,具体参数参考 https://reference.univer.ai/zh-CN/classes/FUniver#loadserverunit
// 或者调用API: univerAPI.loadServerUnit(unitId, 1) 加载文档,具体参数参考 /reference/facade/univer#loadserverunit
```

#### 导入 `.docx` 文件并获取 `IDocumentData`
Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/import-export.zh-TW.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ url.searchParams.set('unit', unitId)
url.searchParams.set('type', '1') // 1 的意思是 String(UniverInstanceType.UNIVER_DOC)
window.location.href = url.toString()

// 或者呼叫API: univerAPI.loadServerUnit(unitId, 1) 載入文件,具體參數參考 https://reference.univer.ai/zh-TW/classes/FUniver#loadserverunit
// 或者呼叫API: univerAPI.loadServerUnit(unitId, 1) 載入文件,具體參數參考 /reference/facade/univer#loadserverunit
```

#### 匯入 `.docx` 檔案並獲取 `IDocumentData`
Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/watermark.ja-JP.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]

ウォーターマーク機能の中核実装を提供するプラグインです。テキスト/画像のウォーターマークを追加でき、外観や挙動を細かく設定できます。`UniverWatermarkPlugin` を提供します。

参考:[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark)
参考:[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark)

## Facade API

Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/watermark.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]

This plugin provides the core implementation of watermark functionality. It allows developers to add text or image watermarks to applications and offers various configuration options to customize the appearance and behavior of the watermark. It provides the `UniverWatermarkPlugin` plugin.

Reference: [@univerjs/watermark](/reference/packages/plugins/univerjs/watermark)
Reference: [@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark)

## Facade API

Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/watermark.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]

本插件提供了水印功能的核心实现。它允许开发者在应用中添加文本或图片水印,并提供多种配置选项来定制水印的外观和行为。其提供了 `UniverWatermarkPlugin` 插件。

参考:[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark)
参考:[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark)

## Facade API

Expand Down
2 changes: 1 addition & 1 deletion content/guides/docs/features/watermark.zh-TW.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]

本外掛提供了水印功能的核心實現。它允許開發者在應用中新增文字或圖片水印,並提供多種配置選項來客製化水印的外觀和行為。其提供了 `UniverWatermarkPlugin` 外掛。

參考:[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark)
參考:[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark)

## Facade API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ univerAPI.createUniverDoc({})
プリセットに含まれないプラグインや独自プラグインを使う場合は `plugins` に登録します。Univer インスタンスを取得した後に `univer.registerPlugin` で登録することもできます。

<Callout>
`createUniver` の詳細は [API Reference / createUniver](/reference/methods/create-univer) を参照してください。
`createUniver` の詳細は [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) を参照してください。
</Callout>

### CDN で Univer を使う
Expand Down Expand Up @@ -262,9 +262,9 @@ npm install @univerjs/<package-name>@alpha # Alpha 版
npm install @univerjs/<package-name>@beta # Beta 版
```

alpha / beta 版で問題が発生した場合は、[Github Issues](https://github.com/dream-num/univer/issues) や [Discord コミュニティ](https://discord.gg/XPGnMBmpd6) などで報告してください。
alpha / beta 版で問題が発生した場合は、[GitHub Issues](https://github.com/dream-num/univer/issues) や [Discord コミュニティ](https://discord.gg/XPGnMBmpd6) などで報告してください。

先行体験をお楽しみください!
これらの早期リリースについてのフィードバックを歓迎します。

## 次のステップ

Expand Down
Loading
Loading