Google Git
Sign in
apache / echarts-doc / refs/tags/4.7.0
commit2390bfb4a24df3ff3939529c0318c1523f517a03[log] [tgz]
authorOvilia <zwl.sjtu@gmail.com>Tue Mar 17 15:57:21 2020 +0800
committerOvilia <zwl.sjtu@gmail.com>Tue Mar 17 15:57:21 2020 +0800
tree6f4e3209bc7a3b48b570309dee3df9f14bb0c724
parent3666d033efbd74ab4285f111399b9ed4e0bd0bfb [diff]
fix typo. close apache/incubator-echarts#12251
1 file changed
tree: 6f4e3209bc7a3b48b570309dee3df9f14bb0c724
  1. .github/
  2. asset/
  3. asset-src/
  4. blog/
  5. blog-src/
  6. build/
  7. config/
  8. en/
  9. public/
  10. slides/
  11. src/
  12. tool/
  13. zh/
  14. .babelrc
  15. .gitignore
  16. _config.yml
  17. build.js
  18. google2e051bafb7b53dc1.html
  19. package-lock.json
  20. package.json
  21. README.md
  22. server.js
README.md

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)