villebro / incubator-echarts-doc

Official repository of ECharts documentation

About

This project is part of the source of The Apache ECharts (incubating) Official Website. See incubator-echarts-website for more details of the building process.

Online Docs

• English
  • Tutorial
  • API
  • Chart Configuration
• 中文
  • Tutorial
  • API
  • Chart Configuration

Development

Document content development

Do not need other project.

npm run dev

It will:

• Start a static server
• Watch doc site src change and rebuild.
• Watch doc markdown change and rebuild.

Tips about writing doc

Global variables can be used in doc:

• galleryViewPath
• galleryEditorPath
• websitePath

For example:

~[700x300](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)

Reference of option

A ~ can be used to refer to a option item in the same doc. For example:

[xAxis.name](~xAxis.name)