Apache Echarts Doc

Clone this repo:
  1. 9ef634f update sankey doc by deqingli · 7 days ago master
  2. 7aba49d add value des of the node in sankey by deqingli · 8 days ago
  3. 4852a7b add emphasis doc for legend selector by deqingli · 10 days ago
  4. ec4077e Merge branch 'master' of https://github.com/apache/incubator-echarts-doc by deqingli · 11 days ago
  5. e70336a update the api doc of chartInstance.clear() by deqingli · 11 days ago

ECharts Documentation

Online Docs

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)