mirrors/VChart
1
0
Fork 0
mirror of https://github.com/VisActor/VChart synced 2024-11-21 23:51:05 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: add links for README

Browse Source
This commit is contained in:
kkxxkk2019 2023-07-19 16:16:11 +08:00 committed by Weixing Zhang
parent 464e98c28d
commit 8e7ce8c2e5
3 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -13,11 +13,11 @@
VChart, more than just a cross-platform charting library, but also an expressive data storyteller. VChart, more than just a cross-platform charting library, but also an expressive data storyteller.
<p align="center"> <p align="center">
<a href="">Introduction</a> • <a href="https://www.visactor.io/vchart">Introduction</a> •
<a href="">Demo</a> • <a href="https://www.visactor.io/vchart/example">Demo</a> •
<a href="">Tutorial</a> • <a href="https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Website_Guide">Tutorial</a> •
<a href="">API</a>• <a href="https://www.visactor.io/vchart/option/barChart">API</a>•
<a href="">Cross-Platform</a> <a href="https://www.visactor.io/vchart/guide/tutorial_docs/cross-terminal_and_developer_ecology/node">Cross-Platform</a>
</p> </p>
![](https://github.com/visactor/vchart/actions/workflows/bug-server.yml/badge.svg) ![](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 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 3. **Scenes**: Deliver visual storytelling capabilities to end-users, unlock developer productivity
## Repo Intro ### Repository Introduction
This repository includes the following packages: This repository includes the following packages:

10
README.zh-CN.md
View File

@ -13,11 +13,11 @@
VChart，不只是开箱即用的多端图表库，更是生动灵活的数据故事讲述者。 VChart，不只是开箱即用的多端图表库，更是生动灵活的数据故事讲述者。
<p align="center"> <p align="center">
<a href="">简介</a> • <a href="https://www.visactor.io/vchart">简介</a> •
<a href="">Demo</a> • <a href="https://www.visactor.io/vchart/example">Demo</a> •
<a href="">教程</a> • <a href="https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Website_Guide">教程</a> •
<a href="">API</a>• <a href="https://www.visactor.io/vchart/option/barChart">API</a>•
<a href="">跨端</a> <a href="https://www.visactor.io/vchart/guide/tutorial_docs/cross-terminal_and_developer_ecology/node">跨端</a>
</p> </p>
![](https://github.com/visactor/vchart/actions/workflows/bug-server.yml/badge.svg) ![](https://github.com/visactor/vchart/actions/workflows/bug-server.yml/badge.svg)

15
packages/react-vchart/docs/README.md Normal file
View File

@ -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)