Apache Echarts Doc

Clone this repo:
  1. 3b5949e Merge branch 'release' by SHUANG SU · 5 hours ago master
  2. 78283c0 rebuild by SHUANG SU · 5 hours ago release
  3. d9c4b97 add encode and dimensions for funnel and pie by Ovilia · 16 hours ago
  4. c1089b1 feat: support polar radius array apache/incubator-echarts@b5e6ba7 by Ovilia · 4 days ago
  5. e26c808 add doc for polar roundCap apache/incubator-echarts#11393 by Ovilia · 5 days ago

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)