docs: update readme in site

This commit is contained in:
Yanyan-Wang 2023-11-10 13:44:42 +08:00
parent 175a3f79b1
commit d7042e720f
4 changed files with 84 additions and 4 deletions

View File

@ -1,3 +1,44 @@
---
title: README
---
## New Feature Introduction
[Introduction](../manual/introduction.zh.md).
[Features DEMO](/zh/examples#feature-features).
## Upgrade Guide
[Upgrade Guide](../manual/upgrade.zh.md).
## Quick Start
[Quick Start](../manual/getting-started.zh.md).
## Tutorials
[Tutorials](../manual/tutorial/example.zh.md).
## Contributing
```
# Install dependencies in the root directory of the project
$ pnpm install
# Navigate to the g6 package directory from the root directory
$ cd packages/g6
# Build
$ npm run build
# Start the integration test demo
$ npm run dev
# Run all unit tests
$ npm run test
# Run the official website. Make sure the g6 package is already built before this step
$ cd packages/site
$ tnpm start
```

View File

@ -2,6 +2,45 @@
title: README
---
TODO
## 新功能介绍
包括接入指南,开发指南,迁移指南的链接。
[新功能介绍](../manual/introduction.zh.md)。
[新功能 DEMO](/zh/examples#feature-features)。
## 升级指南
[快速上手](../manual/upgrade.zh.md)。
## 快速上手
[升级指南](../manual/getting-started.zh.md)。
## 入门教程
[入门教程](../manual/tutorial/example.zh.md)。
## 参与开发
```
# 在项目的根目录安装依赖
$ pnpm install
# 从项目根目录进入到 g6 包文件目录下
$ cd packages/g6
# 构建
$ npm run build
# 启动集成测试 demo
$ npm run dev
# 运行所有单元测试
$ npm run test
# 运行官网,在此之前请确保 g6 包已经构建
$ cd packages/site
$ tnpm start
```

View File

@ -90,7 +90,7 @@ Inner data is the data generated after the transformation stage in the Transform
Mappers are used to map the inner data to specific visual channels. They map the internal data to specific node styles, edge styles, labels, and other visual attributes based on predefined rules and configurations. Mappers support JSON-based configurations as well as function-based configurations.
Mappers are configured using the `node`, `edge`, or `combo` fields in the graph configuration. The types of mappers can be found in: TODO. [A Demo for Mappers](/en/examples/feature/features/#lodLevels).
Mappers are configured using the `node`, `edge`, or `combo` fields in the graph configuration. The types of mappers can be found in [specification.node](../graph/Specification.en.md#node), [specification.edge](../graph/Specification.en.md#edge), [specification.combo](../graph/Specification.en.md#combo). [A Demo for Mappers](/en/examples/feature/features/#lodLevels).
### Display Data

View File

@ -88,7 +88,7 @@ graph.removeData('node', ['node-1', 'node-2']);
数据映射器是用于将内部流转数据映射到具体的视觉通道上。它们根据预定义的规则和配置,将内部数据映射到特定的节点样式、边样式、标签等可视化属性上。数据映射器支持 JSON 格式的配置,也支持函数式的配置。
使用图配置中的 `node``edge`,或 `combo`,类型见:TODO。 [Mappers DEMO](/zh/examples/feature/features/#lodLevels).
使用图配置中的 `node``edge`,或 `combo`,类型见:[specification.node](../graph/Specification.zh.md#node), [specification.edge](../graph/Specification.zh.md#edge), [specification.combo](../graph/Specification.zh.md#combo)。 [Mappers DEMO](/zh/examples/feature/features/#lodLevels).
### Display Data 渲染数据