Official repository of ECharts documentation

Clone this repo:
  1. 52e0042 doc: update readme and license by Ovilia · 2 days ago master
  2. 67641ca Merge pull request #132 from xiaohp/master by Zhongxiang.Wang · 3 weeks ago
  3. 3fea10d fix webpack url by xiaohai · 4 weeks ago
  4. 159ff36 fix webpack url by xiaohai · 4 weeks ago
  5. 0acc6a3 fix property desc popup display wrong. by pissang · 7 weeks ago

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

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)