Google Git
Sign in
apache / echarts-doc / b90521b623fdce39563245867299280f427d8709 / .
tree: a09856698eeeebb0fe28e871873ff40f33fa57fb [path history] [tgz]
  1. .github/
  2. asset/
  3. blog/
  4. blog-src/
  5. config/
  6. en/
  7. public/
  8. slides/
  9. tool/
  10. zh/
  11. .gitignore
  12. _config.yml
  13. build.js
  14. google2e051bafb7b53dc1.html
  15. package-lock.json
  16. package.json
  17. README.md
  18. release.sh
  19. server.js
  20. watch.js
README.md

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)