ECharts Documentation

Online Docs

Build and Run Locally

Dev:

# should put <https://github.com/ecomfe/echarts-examples> on the same folder with echarts-doc
node watch.js --env dev
# or
node build.js --env dev

# Run a static server (optional)
node server.js

Release: Check incubator-echarts-website/README.md please.

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)