Skip to content

Commit bbc0546

Browse files
committed
docs: add get start page
1 parent 933efcd commit bbc0546

File tree

9 files changed

+84
-7
lines changed

9 files changed

+84
-7
lines changed

docs/docs/en/_meta.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
[
2+
{
3+
"text": "guide",
4+
"link": "/guide/introduction/get-start",
5+
"activeMatch": "^/guide/introduction/get-start"
6+
},
27
{
38
"text": "components",
49
"link": "/components",

docs/docs/en/guide/_meta.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[
2+
{
3+
"type": "dir",
4+
"name": "introduction",
5+
"label": "introduction",
6+
"collapsible": true,
7+
"collapsed": false
8+
}
9+
]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { PackageManagerTabs } from '@theme';
2+
3+
# Getting Started
4+
5+
## Prerequisites
6+
7+
MateChat React is a React frontend components and helpers library, we recommend that you use React 18 or above.
8+
9+
If you are looking for the Vue MateChat version, please visit [MateChat Vue](https://matechat.gitcode.com/).
10+
11+
## Quick Start
12+
13+
If you wish to try a brand-new MateChat React project, feel free to use the MateChat CLI to create a template project.
14+
15+
<PackageManagerTabs command="create matechat@latest" />
16+
17+
## Installation
18+
19+
<PackageManagerTabs command="add @matechat/react" npm="install @matechat/react" />

docs/docs/en/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ hero:
66
text: AI scenario solution
77
tagline: A frontend AI scenario solution UI library based on DevUI Design
88
actions:
9-
# - theme: brand
10-
# text: Quick Start
11-
# link: /guide/start/introduction
9+
- theme: brand
10+
text: Quick Start
11+
link: /guide/introduction/get-start
1212
- theme: alt
1313
text: GitHub
1414
link: https://github.com/DevCloudFE/matechat-react

docs/docs/zh/_meta.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
[
2+
{
3+
"text": "guide",
4+
"link": "/zh/guide/introduction/get-start",
5+
"activeMatch": "^/zh/guide/introduction/get-start"
6+
},
27
{
38
"text": "components",
49
"link": "/zh/components",

docs/docs/zh/guide/_meta.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[
2+
{
3+
"type": "dir",
4+
"name": "introduction",
5+
"label": "introduction",
6+
"collapsible": true,
7+
"collapsed": false
8+
}
9+
]
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { PackageManagerTabs } from "@theme";
2+
3+
# 快速开始
4+
5+
## 前置条件
6+
7+
MateChat React 是一个 React 前端组件和助手库,我们建议您使用 React 18 或以上版本。
8+
9+
如果您正在寻找 MateChat 的 Vue 版本,请访问[MateChat Vue](https://matechat.gitcode.com/)
10+
11+
## 快速开始
12+
13+
如果你希望尝试一个全新的 MateChat React,欢迎使用 MateChat 脚手架来创建一个模板项目。
14+
15+
<PackageManagerTabs command="create matechat@latest" />
16+
17+
## 手动安装
18+
19+
<PackageManagerTabs
20+
command="add @matechat/react"
21+
npm="install @matechat/react"
22+
/>

docs/docs/zh/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ hero:
66
text: AI 场景解决方案
77
tagline: 基于 DevUI Design 的 AI 场景前端解决方案
88
actions:
9-
# - theme: brand
10-
# text: 快速开始
11-
# link: guide/start/introduction
9+
- theme: brand
10+
text: 快速开始
11+
link: /zh/guide/introduction/get-start
1212
- theme: alt
1313
text: GitHub
1414
link: https://github.com/DevCloudFE/matechat-react
@@ -39,4 +39,4 @@ features:
3939
- title: 面向生产环境准备
4040
details: 经过良好测试,可无缝集成至 Next.js、Vite、等主流 React 应用中。
4141
icon: 🚀
42-
---
42+
---

docs/i18n.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,13 @@
1010
"interaction": {
1111
"zh": "交互",
1212
"en": "Interaction"
13+
},
14+
"introduction": {
15+
"zh": "介绍",
16+
"en": "Introduction"
17+
},
18+
"guide": {
19+
"zh": "指南",
20+
"en": "Guide"
1321
}
1422
}

0 commit comments

Comments
 (0)