diff --git a/README.md b/README.md index 203a1029b..ed3964da9 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ VChart, more than just a cross-platform charting library, but also an expressive data storyteller.
- Introduction • - Demo • - Tutorial • - API• - Cross-Platform + Introduction • + Demo • + Tutorial • + API• + Cross-Platform
![](https://github.com/visactor/vchart/actions/workflows/bug-server.yml/badge.svg) @@ -50,7 +50,7 @@ VChart is a charting component library in VisActor visualization system. It wrap 2. **Storytelling**: Comprehensive annotation, animation, flow control, narrative templates, and other enhanced features for visual storytelling 3. **Scenes**: Deliver visual storytelling capabilities to end-users, unlock developer productivity -## Repo Intro +### Repository Introduction This repository includes the following packages: diff --git a/README.zh-CN.md b/README.zh-CN.md index 7960ead9e..2c20693c8 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -13,11 +13,11 @@ VChart,不只是开箱即用的多端图表库,更是生动灵活的数据故事讲述者。- 简介 • - Demo • - 教程 • - API• - 跨端 + 简介 • + Demo • + 教程 • + API• + 跨端
![](https://github.com/visactor/vchart/actions/workflows/bug-server.yml/badge.svg) diff --git a/packages/react-vchart/docs/README.md b/packages/react-vchart/docs/README.md new file mode 100644 index 000000000..3fb556536 --- /dev/null +++ b/packages/react-vchart/docs/README.md @@ -0,0 +1,15 @@ +## 文档指引 + +1. [快速开始](./1.%20%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md) + - 环境要求 + - 安装 + - 引入 `@visactor/react-vchart` + - 绘制一个简单的柱状图 +2. 入门 + - [API 设计](./2.1%20API%E8%AE%BE%E8%AE%A1.md) + - [统一图表标签](.//2.2%20%E7%BB%9F%E4%B8%80%E5%9B%BE%E8%A1%A8%E6%A0%87%E7%AD%BE.md) + - [语法化标签](./2.3%20%E8%AF%AD%E6%B3%95%E5%8C%96%E6%A0%87%E7%AD%BE.md) +3. [事件交互](./3.%20%E4%BA%8B%E4%BB%B6%E4%BA%A4%E4%BA%92.md) +4. [主题样式](./4.%20%E4%B8%BB%E9%A2%98%E6%A0%B7%E5%BC%8F.md) +5. [FAQ](./5.%20FAQ.md) +6. [更新日志](./6.%20%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97.md)