feat: update docs

This commit is contained in:
chenos 2022-10-07 12:11:21 +08:00
parent 778bb77d6a
commit d2411f5b63
36 changed files with 73 additions and 33 deletions

View File

@ -115,13 +115,13 @@ export default defineConfig({
], ],
'zh-CN': [ 'zh-CN': [
{ {
title: '介绍', title: '欢迎',
path: '/introduction' path: '/welcome'
},
{
title: '快速开始',
path: '/getting-started'
}, },
// {
// title: '快速开始',
// path: '/getting-started'
// },
{ {
title: '使用手册', title: '使用手册',
path: '/manual' path: '/manual'
@ -134,6 +134,10 @@ export default defineConfig({
title: 'API 参考', title: 'API 参考',
path: '/api' path: '/api'
}, },
// {
// title: '社区',
// path: '/community'
// },
{ {
title: 'GitHub', title: 'GitHub',
path: 'https://github.com/nocobase/nocobase', path: 'https://github.com/nocobase/nocobase',

View File

@ -1,26 +1,47 @@
export default { export default {
'/introduction': [ '/welcome': [
'/introduction/index', {
'/introduction/features', title: 'Welcome',
'/introduction/when', 'title.zh-CN': '欢迎',
'/introduction/quickstart', type: 'group',
'/introduction/roadmap', children: [
'/introduction/thanks', '/welcome/introduction/index',
'/welcome/introduction/features',
'/welcome/introduction/when',
'/welcome/introduction/learning-guide',
], ],
'/getting-started': [ },
{
title: 'Getting started',
'title.zh-CN': '快速开始',
type: 'group',
children: [
{ {
title: 'Installation', title: 'Installation',
'title.zh-CN': '安装', 'title.zh-CN': '安装',
type: 'subMenu', type: 'subMenu',
children: [ children: [
'/getting-started/installation/index', '/welcome/getting-started/installation/index',
'/getting-started/installation/docker-compose', '/welcome/getting-started/installation/docker-compose',
'/getting-started/installation/create-nocobase-app', '/welcome/getting-started/installation/create-nocobase-app',
'/getting-started/installation/git-clone', '/welcome/getting-started/installation/git-clone',
],
},
'/welcome/getting-started/upgrading',
'/welcome/getting-started/deployment',
],
},
{
title: 'Community',
'title.zh-CN': '社区',
type: 'group',
children: [
'/welcome/community/contributing',
'/welcome/community/faq',
'/welcome/community/translations',
'/welcome/community/thanks',
], ],
}, },
'/getting-started/upgrading',
// '/getting-started/deployment',
], ],
'/manual': [ '/manual': [
'/manual/functional-zoning', '/manual/functional-zoning',
@ -42,7 +63,6 @@ export default {
children: [ children: [
'/development/index', '/development/index',
'/development/your-fisrt-plugin', '/development/your-fisrt-plugin',
'/development/learning-guide',
], ],
}, },
{ {

1
docs/zh-CN/index.md Normal file
View File

@ -0,0 +1 @@
<Redirect to="/welcome/introduction" />

View File

@ -0,0 +1 @@
# 常见问题

View File

@ -15,7 +15,7 @@ https://github.com/nocobase/nocobase/tree/main/packages/core/client/src/locale
请复制 en_US.ts命名为想要新增的语言的名字然后对其中的字符串进行翻译。翻译完成之后请通过 pull request 提交给 NocoBase我们将会把它加入语言列表。之后你将在系统配置中看到新增的语言在这里你可以配置需要显示哪些语言供用户选择。 请复制 en_US.ts命名为想要新增的语言的名字然后对其中的字符串进行翻译。翻译完成之后请通过 pull request 提交给 NocoBase我们将会把它加入语言列表。之后你将在系统配置中看到新增的语言在这里你可以配置需要显示哪些语言供用户选择。
<img src="../images/enabled-languages.jpg" style="max-width: 800px;"/> <img src="../../images/enabled-languages.jpg" style="max-width: 800px;"/>
下面的表格中列出了 Language Culture Name, Locale File Name, Display Name. 下面的表格中列出了 Language Culture Name, Locale File Name, Display Name.

View File

Before

Width:  |  Height:  |  Size: 213 KiB

After

Width:  |  Height:  |  Size: 213 KiB

View File

Before

Width:  |  Height:  |  Size: 3.8 MiB

After

Width:  |  Height:  |  Size: 3.8 MiB

View File

@ -1,4 +1,4 @@
# 概述 # 介绍
![](https://www.nocobase.com/images/demo/11.png) ![](https://www.nocobase.com/images/demo/11.png)

View File

@ -1,8 +1,10 @@
# 学习路线指南 # 学习路线指南
## 第一步:从安装运行 NocoBase 开始 ## 1. 从安装运行 NocoBase 开始
主要的命令包括: **相关文档:<a href="/welcome/getting-started/installation" target="_blank">快速开始</a>**
主要命令包括:
下载 下载
@ -28,7 +30,9 @@ yarn build
yarn start yarn start
``` ```
## 第二步:了解 NocoBase 平台提供的核心功能 ## 2. 了解 NocoBase 平台提供的核心功能
**相关文档:<a href="/manual" target="_blank">使用手册</a>**
主要的三部分包括: 主要的三部分包括:
@ -36,7 +40,9 @@ yarn start
- 插件管理器:功能需求扩展 - 插件管理器:功能需求扩展
- 配置中心:已激活插件提供的配置功能 - 配置中心:已激活插件提供的配置功能
## 第三步:进一步了解插件管理器的使用 ## 3. 进一步了解插件管理器的使用
**相关文档:<a href="/development" target="_blank">插件开发</a>**
NocoBase 提供了简易的插件管理器界面,但是在界面上只能处理本地插件的 enable、disable 和 remove完整的操作需要通过 CLI NocoBase 提供了简易的插件管理器界面,但是在界面上只能处理本地插件的 enable、disable 和 remove完整的操作需要通过 CLI
@ -55,7 +61,9 @@ yarn pm remove hello
更多插件示例,查看 packages/samples通过 samples 插件能够了解插件的基本用法,就可以进一步开发插件了。 更多插件示例,查看 packages/samples通过 samples 插件能够了解插件的基本用法,就可以进一步开发插件了。
## 第四步:开发新插件,了解模块分布 ## 4. 开发新插件,了解模块分布
**相关文档:<a href="/development/guide" target="_blank">扩展指南</a>**
[编写第一个插件](/development/your-fisrt-plugin) 章节,虽然简单的讲述了插件的主要开发流程,但是为了更快速的介入插件细节,你可能需要进一步了解 NocoBase 框架的模块分布: [编写第一个插件](/development/your-fisrt-plugin) 章节,虽然简单的讲述了插件的主要开发流程,但是为了更快速的介入插件细节,你可能需要进一步了解 NocoBase 框架的模块分布:
@ -74,7 +82,9 @@ yarn pm remove hello
- Commands自定义命令行 - Commands自定义命令行
- Migrations迁移脚本 - Migrations迁移脚本
## 第五步:查阅各模块主要 API ## 5. 查阅各模块主要 API
**相关文档:<a href="/api" target="_blank">API 参考</a>**
查看各模块的 packages/samples进一步了解模块主要 API 的用法 查看各模块的 packages/samples进一步了解模块主要 API 的用法

View File

Before

Width:  |  Height:  |  Size: 2.5 MiB

After

Width:  |  Height:  |  Size: 2.5 MiB

View File

Before

Width:  |  Height:  |  Size: 715 KiB

After

Width:  |  Height:  |  Size: 715 KiB

View File

Before

Width:  |  Height:  |  Size: 354 KiB

After

Width:  |  Height:  |  Size: 354 KiB

View File

Before

Width:  |  Height:  |  Size: 1.7 MiB

After

Width:  |  Height:  |  Size: 1.7 MiB

View File

Before

Width:  |  Height:  |  Size: 335 KiB

After

Width:  |  Height:  |  Size: 335 KiB

View File

Before

Width:  |  Height:  |  Size: 499 KiB

After

Width:  |  Height:  |  Size: 499 KiB

View File

Before

Width:  |  Height:  |  Size: 499 KiB

After

Width:  |  Height:  |  Size: 499 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 429 KiB

After

Width:  |  Height:  |  Size: 429 KiB

View File

Before

Width:  |  Height:  |  Size: 990 KiB

After

Width:  |  Height:  |  Size: 990 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 MiB

After

Width:  |  Height:  |  Size: 2.0 MiB

View File

Before

Width:  |  Height:  |  Size: 410 KiB

After

Width:  |  Height:  |  Size: 410 KiB

View File

Before

Width:  |  Height:  |  Size: 803 KiB

After

Width:  |  Height:  |  Size: 803 KiB

View File

Before

Width:  |  Height:  |  Size: 803 KiB

After

Width:  |  Height:  |  Size: 803 KiB

View File

@ -0,0 +1,4 @@
import { Redirect } from 'dumi';
import React from 'react';
export default (props) => <Redirect {...props} />;