VChart/docs/README.zh-CN.md
2023-08-31 19:04:10 +08:00

1.7 KiB

VChart 站点

该文件夹存储的是 VChart 站点相关的工程,同时也包含站点所有的中英文文档、图表示例代码等内容。

目录说明

文档内容

文档的内容都存储在 assets 文件夹下,

assets
├── api                 # VChart api 接口文档
│   ├── en              # 英文文档目录
│   ├── menu.json       # VChart api 接口文档的索引配置
│   └── zh              # 中文文档目录
├── demos               # VChart 网站首页的一些 demo
│   ├── builtin-theme
│   ├── chart-history
│   ├── qixi
│   └── template
├── examples            # VChart 图表示例
│   ├── en              # VChart 图表示例英文版
│   ├── menu.json       # VChart 图表示例文档的索引配置
│   └── zh              # VChart 图表示例中文版
├── options             # VChart 配置项文档
│   ├── en              # VChart 配置项文档英文本
│   └── zh              # VChart 配置项文档中文本
├── themes              # VChart 图表主题
│   ├── dark            # VChart 图表暗黑主题
│   └── light           # VChart 图表默认主题
└── tutorials           # VChart 教程文档
    ├── en              # VChart 教程文档英文版
    ├── menu.json       # VChart 教程文档的索引配置
    └── zh              # VChart 教程文档中文版

项目代码

项目的代码都位于 src 文件夹下

如何启动

# 全局命令
$ rush docs

# 也可以进入 docs 文件夹内,然后运行
$ rushx start