Official repository of ECharts documentation

Clone this repo:
  1. 343c470 unify contributors name with github id in changelog. by pissang · 2 days ago master
  2. f37e7bd add changelog of 4.9.0 by pissang · 3 days ago
  3. 308155f fix: build script. by 100pah · 3 days ago
  4. 885aff3 fix: doc source change from json js by pissang · 7 days ago
  5. 92f689d Merge pull request #126 from psimyn/patch-1 by Zhongxiang.Wang · 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)