mirror of
https://github.com/alibaba/lowcode-engine.git
synced 2025-12-11 18:42:56 +00:00
chore: change recommended node version to 16.18, and fix some minor doc link issues (#1327)
This commit is contained in:
parent
3fa810d8ce
commit
a54ded2fd6
@ -16,4 +16,4 @@ jobs:
|
|||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
issue-number: ${{ github.event.issue.number }}
|
issue-number: ${{ github.event.issue.number }}
|
||||||
body: |
|
body: |
|
||||||
你好 @${{ github.event.issue.user.login }},由于缺乏必要的信息(如 bug 重现步骤、引擎版本信息 等),无法定位问题,请按照 [issue bug 模板](https://github.com/alibaba/lowcode-engine/blob/main/.github/ISSUE_TEMPLATE/bug-report.md) 补全信息,也可以通过阅读[引擎的 issue 说明](https://www.yuque.com/lce/doc/yvlxhs) 了解什么类型的 issue 可以获得更好、更快的支持。
|
你好 @${{ github.event.issue.user.login }},由于缺乏必要的信息(如 bug 重现步骤、引擎版本信息 等),无法定位问题,请按照 [issue bug 模板](https://github.com/alibaba/lowcode-engine/blob/main/.github/ISSUE_TEMPLATE/bug-report.md) 补全信息,也可以通过阅读 [引擎的 issue 说明](https://lowcode-engine.cn/site/community/issue) 了解什么类型的 issue 可以获得更好、更快的支持。
|
||||||
|
|||||||
@ -11,7 +11,7 @@ title: 快速开始
|
|||||||
### WSL(Window 电脑)
|
### WSL(Window 电脑)
|
||||||
Window 环境需要使用 WSL 在 windows 下进行低代码引擎相关的开发。安装教程 ➡️ [WSL 安装教程](https://docs.microsoft.com/zh-cn/windows/wsl/install)。<br />**对于 Window 环境来说,之后所有需要执行命令的操作都是在 WSL 终端执行的。**
|
Window 环境需要使用 WSL 在 windows 下进行低代码引擎相关的开发。安装教程 ➡️ [WSL 安装教程](https://docs.microsoft.com/zh-cn/windows/wsl/install)。<br />**对于 Window 环境来说,之后所有需要执行命令的操作都是在 WSL 终端执行的。**
|
||||||
### Node
|
### Node
|
||||||
node 版本推荐 14.17.0。
|
node 版本推荐 16.18.0。
|
||||||
|
|
||||||
#### 查看 Node 版本
|
#### 查看 Node 版本
|
||||||

|

|
||||||
|
|||||||
@ -9,7 +9,7 @@ sidebar_position: 1
|
|||||||
如果您需要对低代码编辑器进行定制,您可能只需要 clone [lowcode-demo 项目](https://github.com/alibaba/lowcode-demo)并进行修改,参考“[配置低代码扩展点](/site/docs/guide/expand/editor/summary)”章节。
|
如果您需要对低代码编辑器进行定制,您可能只需要 clone [lowcode-demo 项目](https://github.com/alibaba/lowcode-demo)并进行修改,参考“[配置低代码扩展点](/site/docs/guide/expand/editor/summary)”章节。
|
||||||
|
|
||||||
> 前置条件:
|
> 前置条件:
|
||||||
> node >= 14
|
> node 推荐使用 16.18.0(14.x 也可以)
|
||||||
|
|
||||||
### 1. 拉取代码,启动项目
|
### 1. 拉取代码,启动项目
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@alilc/lowcode-engine-docs",
|
"name": "@alilc/lowcode-engine-docs",
|
||||||
"version": "1.0.4",
|
"version": "1.0.5",
|
||||||
"description": "低代码引擎版本化文档",
|
"description": "低代码引擎版本化文档",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"files": [
|
"files": [
|
||||||
|
|||||||
@ -41,7 +41,7 @@
|
|||||||
- 🌈 提炼自企业级低代码平台的面向扩展设计的内核引擎,奉行最小内核,最强生态的设计理念
|
- 🌈 提炼自企业级低代码平台的面向扩展设计的内核引擎,奉行最小内核,最强生态的设计理念
|
||||||
- 📦 开箱即用的高质量生态元素,包括 物料体系、设置器、插件 等
|
- 📦 开箱即用的高质量生态元素,包括 物料体系、设置器、插件 等
|
||||||
- ⚙️ 完善的工具链,支持 物料体系、设置器、插件 等生态元素的全链路研发周期
|
- ⚙️ 完善的工具链,支持 物料体系、设置器、插件 等生态元素的全链路研发周期
|
||||||
- 🔌 强大的扩展能力,已支撑近 100 个各种垂直类低代码平台
|
- 🔌 强大的扩展能力,已支撑 100+ 个各种类型低代码平台
|
||||||
- 🛡 使用 TypeScript 开发,提供完整的类型定义文件
|
- 🛡 使用 TypeScript 开发,提供完整的类型定义文件
|
||||||
|
|
||||||
## 🎯 兼容环境
|
## 🎯 兼容环境
|
||||||
@ -126,9 +126,9 @@ https://cdn.jsdelivr.net/npm/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/
|
|||||||
- [官方物料](https://github.com/alibaba/lowcode-materials)
|
- [官方物料](https://github.com/alibaba/lowcode-materials)
|
||||||
- [官方设置器(setter)](https://github.com/alibaba/lowcode-engine-ext)
|
- [官方设置器(setter)](https://github.com/alibaba/lowcode-engine-ext)
|
||||||
- [官方插件(plugin)](https://github.com/alibaba/lowcode-plugins)
|
- [官方插件(plugin)](https://github.com/alibaba/lowcode-plugins)
|
||||||
- [生态元素(物料、setter、插件)工具链](https://www.yuque.com/lce/doc/ulvlkz)
|
- [生态元素(物料、setter、插件)工具链](https://lowcode-engine.cn/site/docs/guide/expand/editor/cli)
|
||||||
- [用户文档](https://lowcode-engine.cn/docV2)
|
- [用户文档](https://lowcode-engine.cn/doc)
|
||||||
- [API](https://lowcode-engine.cn/docV2/vlmeme)
|
- [API](https://lowcode-engine.cn/site/docs/api/)
|
||||||
|
|
||||||
[awesome-lowcode-engine](https://github.com/lowcode-workspace/awesome-lowcode-engine) 中包含了一系列围绕引擎建设的工具、解决方案等,如果你有类似的解决方案或者工具,欢迎提 PR 到该仓库,让更多人了解到
|
[awesome-lowcode-engine](https://github.com/lowcode-workspace/awesome-lowcode-engine) 中包含了一系列围绕引擎建设的工具、解决方案等,如果你有类似的解决方案或者工具,欢迎提 PR 到该仓库,让更多人了解到
|
||||||
|
|
||||||
@ -146,14 +146,14 @@ $ npm start
|
|||||||
>
|
>
|
||||||
> 📢 windows 环境必须使用 [WSL](https://docs.microsoft.com/zh-cn/windows/wsl/install),其他终端不保证能正常运行
|
> 📢 windows 环境必须使用 [WSL](https://docs.microsoft.com/zh-cn/windows/wsl/install),其他终端不保证能正常运行
|
||||||
|
|
||||||
lowcode-engine 启动后,提供了几个 umd 文件,可以结合 [lowcode-demo](https://github.com/alibaba/lowcode-demo) 项目做调试,文件代理规则参考[这里](https://www.yuque.com/lce/doc/glz0fx)。
|
lowcode-engine 启动后,提供了几个 umd 文件,可以结合 [lowcode-demo](https://github.com/alibaba/lowcode-demo) 项目做调试,文件代理规则参考[这里](https://lowcode-engine.cn/site/docs/participate/prepare#2-配置资源代理)。
|
||||||
|
|
||||||
## 🤝 参与共建
|
## 🤝 参与共建
|
||||||
|
|
||||||
请先阅读:
|
请先阅读:
|
||||||
1. [如何配置引擎调试环境?](https://www.yuque.com/lce/doc/glz0fx)
|
1. [如何配置引擎调试环境?](https://lowcode-engine.cn/site/docs/participate/prepare)
|
||||||
2. [关于引擎的研发协作流程](https://www.yuque.com/lce/doc/contributing)
|
2. [关于引擎的研发协作流程](https://lowcode-engine.cn/site/docs/participate/flow)
|
||||||
3. [引擎的工程化配置](https://www.yuque.com/lce/doc/gxwqg6)
|
3. [引擎的工程化配置](https://lowcode-engine.cn/site/docs/participate/config)
|
||||||
|
|
||||||
> 强烈推荐阅读 [《提问的智慧》](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/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393),更好的问题更容易获得帮助。(此段参考 [antd](https://github.com/ant-design/ant-design))
|
> 强烈推荐阅读 [《提问的智慧》](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/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393),更好的问题更容易获得帮助。(此段参考 [antd](https://github.com/ant-design/ant-design))
|
||||||
|
|
||||||
|
|||||||
@ -126,9 +126,9 @@ Pass the files under packages/engine/dist and packages/(react|rax)-simulator-ren
|
|||||||
- [Official Materials](https://github.com/alibaba/lowcode-materials)
|
- [Official Materials](https://github.com/alibaba/lowcode-materials)
|
||||||
- [official setter](https://github.com/alibaba/lowcode-engine-ext)
|
- [official setter](https://github.com/alibaba/lowcode-engine-ext)
|
||||||
- [Official plugin (plugin)](https://github.com/alibaba/lowcode-plugins)
|
- [Official plugin (plugin)](https://github.com/alibaba/lowcode-plugins)
|
||||||
- [Ecological elements (materials, setters, plugins) toolchain](https://www.yuque.com/lce/doc/ulvlkz)
|
- [Ecological elements (materials, setters, plugins) toolchain](https://lowcode-engine.cn/site/docs/guide/expand/editor/cli)
|
||||||
- [User Documentation](http://lowcode-engine.cn/docV2)
|
- [User Documentation](http://lowcode-engine.cn/doc)
|
||||||
- [API](http://lowcode-engine.cn/docV2/vlmeme)
|
- [API](https://lowcode-engine.cn/site/docs/api/)
|
||||||
|
|
||||||
This [awesome-lowcode-engine](https://github.com/lowcode-workspace/awesome-lowcode-engine) page links to a repository which records all of the tools\materials\solutions that use or built for the lowcode-engine, PR is welcomed.
|
This [awesome-lowcode-engine](https://github.com/lowcode-workspace/awesome-lowcode-engine) page links to a repository which records all of the tools\materials\solutions that use or built for the lowcode-engine, PR is welcomed.
|
||||||
|
|
||||||
@ -146,14 +146,14 @@ $ npm start
|
|||||||
>
|
>
|
||||||
> 📢 Windows environment must use [WSL](https://docs.microsoft.com/en-us/windows/wsl/install), other terminals are not guaranteed to work normally
|
> 📢 Windows environment must use [WSL](https://docs.microsoft.com/en-us/windows/wsl/install), other terminals are not guaranteed to work normally
|
||||||
|
|
||||||
After lowcode-engine is started, several umd files are provided, which can be debugged in combination with the [lowcode-demo](https://github.com/alibaba/lowcode-demo) project. Refer to the file proxy rules [here](https://www.yuque.com/lce/doc/glz0fx).
|
After lowcode-engine is started, several umd files are provided, which can be debugged in combination with the [lowcode-demo](https://github.com/alibaba/lowcode-demo) project. Refer to the file proxy rules [here](https://lowcode-engine.cn/site/docs/participate/prepare).
|
||||||
|
|
||||||
## 🤝 Participation
|
## 🤝 Participation
|
||||||
|
|
||||||
Please read first:
|
Please read first:
|
||||||
1. [How to configure the engine debugging environment? ](https://www.yuque.com/lce/doc/glz0fx)
|
1. [How to configure the engine debugging environment? ](https://lowcode-engine.cn/site/docs/participate/prepare)
|
||||||
2. [About the R&D collaboration process of the engine](https://www.yuque.com/lce/doc/contributing)
|
2. [About the R&D collaboration process of the engine](https://lowcode-engine.cn/site/docs/participate/flow)
|
||||||
3. [Engineering Configuration of Engine](https://www.yuque.com/lce/doc/gxwqg6)
|
3. [Engineering Configuration of Engine](https://lowcode-engine.cn/site/docs/participate/config)
|
||||||
|
|
||||||
> Strongly recommend reading ["The Wisdom of Asking Questions"](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html), [ "How to Submit Unanswerable Questions to Open Source Projects"](https://zhuanlan.zhihu.com/p/25795393), better questions are easier to get help. (This paragraph refers to [antd](https://github.com/ant-design/ant-design))
|
> Strongly recommend reading ["The Wisdom of Asking Questions"](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html), [ "How to Submit Unanswerable Questions to Open Source Projects"](https://zhuanlan.zhihu.com/p/25795393), better questions are easier to get help. (This paragraph refers to [antd](https://github.com/ant-design/ant-design))
|
||||||
|
|
||||||
|
|||||||
@ -8,12 +8,12 @@
|
|||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>
|
<h1>
|
||||||
This project only provides engine resource files. For usage, go for
|
This project only provides engine resource files. For usage, go for
|
||||||
<a href="https://github.com/alibaba/lowcode-demo" target="_blank">Lowcode Demo</a>
|
<a href="https://github.com/alibaba/lowcode-demo" target="_blank">Lowcode Demo</a>
|
||||||
</h1>
|
</h1>
|
||||||
<h2>
|
<h2>
|
||||||
For local debugging of lowcode engine, please visit
|
For local debugging of lowcode engine, please visit
|
||||||
<a href="https://www.yuque.com/lce/doc/glz0fx#wi8rs" target="_blank">proxy documentation</a>
|
<a href="https://lowcode-engine.cn/site/docs/participate/prepare" target="_blank">proxy documentation</a>
|
||||||
to get more information.
|
to get more information.
|
||||||
</h2>
|
</h2>
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user