Skip to content

Commit 260e179

Browse files
JackLianliujuping
JackLian
authored and
liujuping
committed
feat: add docs site
1 parent 84e0c1f commit 260e179

File tree

128 files changed

+10175
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+10175
-0
lines changed

‎docs/.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎docs/README.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Low-Code Engine 文档中心（site）
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### 安装
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### 本地开发
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### 构建
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
### 部署
26+
```bash
27+
1. npm run build
28+
2. npm publish # 记得改下版本号，比如 1.0.1
29+
30+
# 发布完后执行 tnpm sync
31+
3. tnpm sync
32+
33+
4. 更新 diamond 版本 1.0.1
34+
5. lowcode-engine.cn 站点生效
35+
```
36+
37+
38+
## 功能
39+
- [x] 支持本地离线搜搜
40+
- [x] 版本化文档管理
41+
- [x] 离线静态部署
42+
- [x] 主题（fork 宜搭开发者中心）
43+
44+
## 使用文档
45+
https://docusaurus.io/zh-CN/docs/docs-introduction
46+

‎docs/babel.config.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

docs/code-specification.md renamed to docs/community/code-specification.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: 编码规约
3+
---
4+
15
编码规约
26
---
37

‎docs/community/img/i-see.png‎

141 KB
Loading

‎docs/community/img/you-think.png‎

104 KB
Loading

‎docs/community/issue.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: 关于引擎的 issue 说明
3+
sidebar_position: 2
4+
---
5+
> 提交地址：[https://github.com/alibaba/lowcode-engine/issues](https://github.com/alibaba/lowcode-engine/issues)
6+
7+
### 提交前必读
8+
由于引擎项目复杂，很多问题在复现和沟通上无法花费太多时间，需要大家尽力将复现步骤说明白。
9+
10+
11+
![image.png](./img/you-think.png)
12+
13+
**你以为的 issue**
14+
15+
16+
![image.png](./img/i-see.png)
17+
18+
**我们看到的 issue**
19+
20+
为了更好的进行协作，对引擎 issue 的处理定了一些处理的优先级。请大家认真阅读 Orz.
21+
22+
- 【支持快】通过线上 Demo 地址 + 控制台输入 API 可复现。
23+
- 【支持快】通过线上 Demo + 导入 schema 可复现
24+
- 【支持稍慢】通过线上 Demo + 完整操作步骤可复现
25+
- 【支持稍慢】通过线上 Demo + 变更代码可复现，并清楚的说明变更代码的位置和内容
26+
- 【支持慢】有完整的项目地址，下载下来可直接安装依赖并启动复现的
27+
- 【支持慢】需求类型的由于人力有限，欢迎大家 PR，如能讲清楚背景上下文和场景，项目维护团队更容易给出方案建议或方向指引。
28+
- 【不保证提供支持】其他
29+
- 只有标题没有复现步骤
30+
- 复现步骤不清晰
31+
- 和引擎无关的
32+
33+
### 不同优先级的示例
34+
#### 【支持快】通过线上 Demo 地址 + 控制台输入 API 可复现。
35+
**示例**
36+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387671833-cd44507b-af59-45ec-b0da-f4f0ef61e92e.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=295&id=ub61f0ab8&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1862&originWidth=3322&originalType=binary&ratio=1&rotation=0&showTitle=false&size=5033674&status=done&style=none&taskId=u3646a3b6-4b22-48e7-94e3-564a09cfa24&title=&width=527)
37+
复现步骤：
38+
39+
- 打开线上 demo
40+
- 在控制台输入
41+
```json
42+
// 当前 doc
43+
const doc = window.AliLowCodeEngine.project.currentDocument
44+
45+
// 新建 doc 并成功切换
46+
window.AliLowCodeEngine.project.openDocument({
47+
componentName: 'Page'
48+
});
49+
50+
// 无法切换回来
51+
window.AliLowCodeEngine.project.openDocument('docl4xkca5b')
52+
```
53+
54+
预期效果：
55+
56+
- 使用 openDocument 可以正常的切换回原来的 doc
57+
58+
#### 【支持快】通过线上 demo + 导入 schema 可复现
59+
步骤：
60+
61+
- 使用线上 demo
62+
- 导入下面的 schema
63+
- schema 代码/schema zip 压缩包
64+
- 页面效果如下
65+
66+
期望：
67+
68+
- 页面中的xxx部分和预期不符合，期望的效果是 xxx
69+
70+
#### 【支持稍慢】通过线上 demo + 完整操作步骤可复现
71+
**示例**
72+
1.使用 antd 组件
73+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387998779-9f621c7f-82cb-48ad-94fc-84c2cd46065c.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=906&id=u0ad0726a&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1812&originWidth=3584&originalType=binary&ratio=1&rotation=0&showTitle=false&size=838860&status=done&style=none&taskId=u0a0a9e20-f79e-4c8c-8c82-b304f7b7583&title=&width=1792)
74+
75+
2.拖拽这个组件
76+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656388046560-e07680ee-809a-4ad1-bc47-47c2c00fdd40.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=901&id=u23c8416a&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1802&originWidth=3584&originalType=binary&ratio=1&rotation=0&showTitle=false&size=890196&status=done&style=none&taskId=u7ac32b55-f32c-4215-ac1d-f81f5e986ac&title=&width=1792)
77+
78+
3.配置该属性值为 100
79+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656388075312-7c06f15a-464a-49f0-beb5-19320ea0e454.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=900&id=ua91e7f85&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1800&originWidth=3584&originalType=binary&ratio=1&rotation=0&showTitle=false&size=882142&status=done&style=none&taskId=u61082c8a-1092-4b5b-a2ea-00486cadb71&title=&width=1792)
80+
81+
期望效果：
82+
83+
- 组件同配置一致
84+
85+
#### 【支持稍慢】通过线上 demo + 变更代码可复现，并清楚的说明变更代码的位置和内容
86+
**示例**
87+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387894830-6850815f-e2ee-46bf-a2bf-fdda4d166691.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=377&id=u87419dd1&margin=%5Bobject%20Object%5D&name=image.png&originHeight=754&originWidth=1892&originalType=binary&ratio=1&rotation=0&showTitle=false&size=226627&status=done&style=none&taskId=u88b2bbb8-869c-482c-9510-9d513f6e191&title=&width=946)
88+
89+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387911054-771dd7fc-db90-46ae-b1db-f5f9f7537ed4.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=389&id=u0a370108&margin=%5Bobject%20Object%5D&name=image.png&originHeight=778&originWidth=1917&originalType=binary&ratio=1&rotation=0&showTitle=false&size=229881&status=done&style=none&taskId=ucbc7af71-f0e1-4319-9097-8ad6b936c5e&title=&width=958.5)
90+
91+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387922644-de3f1d64-0206-407d-82ad-2d1155374e37.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=127&id=u9c5921eb&margin=%5Bobject%20Object%5D&name=image.png&originHeight=253&originWidth=1836&originalType=binary&ratio=1&rotation=0&showTitle=false&size=58615&status=done&style=none&taskId=u5c8af90a-0d20-40c8-a1f2-e387f037d85&title=&width=918)
92+
93+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656387931330-a5453ba1-264b-4325-b3a8-7cb6e22633ee.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=457&id=u687acf85&margin=%5Bobject%20Object%5D&name=image.png&originHeight=914&originWidth=1912&originalType=binary&ratio=1&rotation=0&showTitle=false&size=129980&status=done&style=none&taskId=u3a706b70-0da6-484d-857d-1d086f7a4e5&title=&width=956)
94+
95+
#### 【支持慢】有完整的项目地址，下载下来可直接安装依赖并启动复现的
96+
由于完整的项目中有很多冗余的信息，这部分排查起来十分耗时且困难。不推荐使用改方式。
97+
98+
#### 【不保证提供支持】其他
99+
##### 只有标题没有复现步骤
100+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656388351815-e086b980-0828-4c49-ba72-142446313d2d.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=510&id=u79a38c3b&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1020&originWidth=2520&originalType=binary&ratio=1&rotation=0&showTitle=false&size=529258&status=done&style=none&taskId=u3540b08e-9dff-4c72-8ee5-123912439b0&title=&width=1260)
101+
102+
##### 复现步骤不清晰
103+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656388451393-2168e5ca-20de-4781-9e51-20e282dbc0ca.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=833&id=ubaf001f6&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1666&originWidth=3584&originalType=binary&ratio=1&rotation=0&showTitle=false&size=1228630&status=done&style=none&taskId=ub26ed4ff-e0cf-4644-9a65-00ddee4b9e5&title=&width=1792)
104+
105+
##### 和引擎无关的
106+
![image.png](https://cdn.nlark.com/yuque/0/2022/png/2622706/1656388376995-0ab5d7c0-8ff9-49cf-8854-70e9bb3ff87a.png#clientId=uaa040ac3-dccc-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=715&id=uffc59321&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1430&originWidth=2548&originalType=binary&ratio=1&rotation=0&showTitle=false&size=747119&status=done&style=none&taskId=u861d5fa6-f673-4091-8635-ff45adf680e&title=&width=1274)
107+
108+
109+
110+
111+
### 扩展阅读
112+
强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/~sgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。（此段参考 [antd](https://github.com/ant-design/ant-design)）

‎docs/config/navbar.js‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/**
2+
* 此配置的修改，如未生效，可以重新启动下即可
3+
*/
4+
module.exports = {
5+
title: '',
6+
logo: {
7+
alt: 'LowCode-Engine',
8+
src: 'https://img.alicdn.com/imgextra/i2/O1CN01uv6vu822RBCSYLro2_!!6000000007116-55-tps-139-26.svg',
9+
srcDark: 'https://tianshu.alicdn.com/052a190e-c961-4afe-aa4c-49ee9722952d.svg',
10+
},
11+
items: [
12+
{
13+
type: 'doc',
14+
docId: 'guide/quickStart/intro',
15+
position: 'left',
16+
label: '文档',
17+
},
18+
{
19+
type: 'doc',
20+
docId: 'api/index',
21+
position: 'left',
22+
label: 'API',
23+
},
24+
{
25+
type: 'doc',
26+
docId: 'faq/index',
27+
position: 'left',
28+
label: 'FAQ',
29+
},
30+
{
31+
type: 'doc',
32+
docId: 'participate/index',
33+
position: 'left',
34+
label: '参与贡献',
35+
},
36+
{
37+
type: 'doc',
38+
docId: 'article/index',
39+
position: 'left',
40+
label: '文章',
41+
},
42+
{
43+
type: 'doc',
44+
docId: 'demoUsage/intro',
45+
position: 'left',
46+
label: 'Demo 使用文档',
47+
},
48+
{
49+
position: 'left',
50+
href: 'https://developer.aliyun.com/ebook/7507',
51+
label: '技术白皮书',
52+
},
53+
{
54+
position: 'left',
55+
href: 'https://github.com/alibaba/lowcode-engine/releases',
56+
label: '更新日志',
57+
},
58+
{
59+
to: '/community/issue',
60+
position: 'left',
61+
label: '社区',
62+
activeBaseRegex: '/community/',
63+
},
64+
// 版本切换，如需，这里开启即可
65+
// {
66+
// type: 'docsVersionDropdown',
67+
// position: 'right',
68+
// dropdownActiveClassDisabled: true,
69+
// },
70+
// {
71+
{
72+
href: 'https://github.com/alibaba/lowcode-engine',
73+
position: 'right',
74+
className: 'header-github-link',
75+
'aria-label': 'GitHub repository',
76+
},
77+
{
78+
type: 'search',
79+
position: 'right',
80+
},
81+
],
82+
};

‎docs/config/sidebars.js‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* Copyright (c) Facebook, Inc. and its affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
const getDocsFromDir = require('../scripts/getDocsFromDir');
8+
9+
module.exports = {
10+
// 手动配置的导航
11+
// guide: [
12+
// 'guide/quickStart/intro',
13+
// 'guide/quickStart/start',
14+
// {
15+
// type: 'category',
16+
// label: 'FAQ',
17+
// collapsed: false,
18+
// items: getDocsFromDir('guide/quickStart/faq'),
19+
// },
20+
// ],
21+
/**
22+
* 根据当前目录自动生成导航配置
23+
*/
24+
guide: [
25+
{
26+
type: 'autogenerated',
27+
dirName: 'guide', // '.' 即当前的文档文件夹
28+
},
29+
],
30+
api: [
31+
{
32+
type: 'autogenerated',
33+
dirName: 'api',
34+
},
35+
],
36+
faq: [
37+
{
38+
type: 'autogenerated',
39+
dirName: 'faq',
40+
},
41+
],
42+
participate: [
43+
{
44+
type: 'autogenerated',
45+
dirName: 'participate',
46+
},
47+
],
48+
demoUsage: [
49+
{
50+
type: 'autogenerated',
51+
dirName: 'demoUsage',
52+
},
53+
],
54+
// api: getDocsFromDir('api'),
55+
};

‎docs/config/sidebarsCommunity.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
module.exports = {
2+
community: [
3+
{
4+
type: 'autogenerated',
5+
dirName: '.',
6+
},
7+
{
8+
type: 'link',
9+
label: '生态资源',
10+
href: 'https://github.com/lowcode-workspace/awesome-lowcode-engine',
11+
},
12+
],
13+
};

0 commit comments

Comments
 (0)