Merge remote-tracking branch 'origin/develop' into feat/pivot-chart

.gitignore

@@ -96,4 +96,7 @@ packages/vtable-docs/public/en/documents
 packages/vtable-docs/public/*.html
 
 # git-hook
-common/scripts/pre-commit
+common/scripts/pre-commit
+
+# generated documents
+docs/public/documents

.vscode/launch.json

@@ -1,6 +1,15 @@
 {
   "version": "0.1.0",
   "configurations": [
+    {
+      "name": "generate documents",
+      "port": 9229,
+      "program": "${workspaceFolder}/docs/libs/template-parse/build.js",
+      "args": ["--env", "dev", "--watch"],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node"
+    },
     {
       "name": "unit test",
       "type": "pwa-node",

README.md

@@ -52,12 +52,12 @@ The core capabilities are as follows:
 2. Multidimensional analysis: Automatically analyzes and presents multidimensional data.
 3. Strong expressiveness: Provides flexible and powerful graphic capabilities, seamlessly integrating with charts of [VChart](https://github.com/VisActor/VChart).
 
-# Repo Intro
+# Repository Introduction
 
 This repository includes the following packages:
 
-1. vtable: VTable components
-2. vtable-docs: VTable documentation
+1. packages/vtable: The core code repository of VTable
+2. docs: Include VTable site tutorials, demos,apis and options, and also contains all Chinese and English documents.
 
 # Usage
 
@@ -131,7 +131,7 @@ const tableInstance = new VTable.ListTable(option);
 
 [More demos and detailed tutorials](https://visactor.io/vtable)
 
-## ⌨️ Development
+# ⌨️ Development
 
 First of all, please install [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)
 
@@ -149,19 +149,30 @@ $ cd VTable
 $ rush update
 # start vtable demo
 $ cd packages/vtable
+# execute in file path: ./packages/vtable
 $ rushx demo
+# start site development server, execute in file path: ./
+$ rush docs
 ```
-# Related Links
+# 📖 Documents
+
+After installation & clone & update, run docs to preview VTable documents locally.
+
+```bash
+# start vtable document server. execute in file path: ./
+$ rush docs
+```
+## 🔗 Related Links
 
 - [Official website](https://visactor.io/vtable)
 
-# Ecosystem
+# 💫 Ecosystem
 
 | Project                                                     | Description                                                                            |
 | ----------------------------------------------------------- | -------------------------------------------------------------------------------------- |
 | [AI-generated Components](https://visactor.io/ai-vtable)    | AI-generated table component.                                                          |
 
-# Contribution
+# 🤝 Contribution
 
 If you would like to contribute, please read the [Code of Conduct ](./CODE_OF_CONDUCT.md) 和 [ Guide](./CONTRIBUTING.zh-CN.md) first。
 

README.zh-CN.md

@@ -54,8 +54,8 @@ VTable 是 VisActor 可视化体系中的表格组件库，基于可视化渲染
 
 本仓库包含如下 package
 
-1. vtable 表格组件
-2. vtable-docs: 教程文档
+1. packages/vtable：表格组件代码
+2. docs: 教程文档
 
 # Usage使用
 
@@ -128,7 +128,7 @@ const tableInstance = new VTable.ListTable(option);
 ##
 
 [更多 demo 和详细教程](https://visactor.io/vtable)
-## ⌨️ 开发
+# ⌨️ 开发
 
 首先，全局安装 [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)
 
@@ -146,19 +146,30 @@ $ cd VTable
 $ rush update
 # start vtable demo
 $ cd packages/vtable
+# execute in file path: ./packages/vtable
 $ rushx demo
+# start site development server, execute in file path: ./
+$ rush docs
 ```
-# 相关链接
+# 📖 Documents
+
+安装并且更新依赖后，可以执行 docs 命令，开启 VTable 的本地文档预览
+
+```bash
+# start vtable document server. execute in file path: ./
+$ rush docs
+```
+# 🔗 相关链接
 
 - [官网](https://visactor.io/vtable)
 
-# 生态
+# 💫 生态
 
 | 项目                                             | 介绍                                                                      |
 | ------------------------------------------------ | ------------------------------------------------------------------------- |
 | [智能生成组件](https://visactor.io/ai-vtable)    | 基于 AI 的智能表格生成组件                                                |                                                        |
 
-# 参与贡献
+# 🤝 参与贡献
 
 如想参与贡献，请先阅读 [行为准则](./CODE_OF_CONDUCT.md) 和 [贡献指南](./CONTRIBUTING.zh-CN.md)。
 

common/config/rush/command-line.json

@@ -90,6 +90,13 @@
       "description": "Run this command to start VTable development server",
       "safeForSimultaneousRushProcesses": true,
       "shellCommand": "ts-node common/autoinstallers/lint/change-all.ts"
+    },
+    {
+      "commandKind": "global",
+      "name": "docs",
+      "summary": "Start the document development server",
+      "description": "Run this command to start document development server",
+      "shellCommand": "rush run -p @visactor/table -s build:es && rush run -p @internal/docs -s start"
     }
   ],
   "parameters": [