Apache ECharts incubating Handbook

Clone this repo:

Branches

  1. 07d57fe fix type error by pissang · 5 days ago master
  2. c202976 fix type errors by pissang · 5 days ago
  3. 9d8ee44 optimize navbar interaction by pissang · 5 days ago
  4. 0313f3c tweak doc of data-transform. by 100pah · 9 days ago
  5. 8530c23 doc: add data-transform handbook by 100pah · 13 days ago

About

This project is part of the source of The Apache ECharts (incubating) Official Website. See incubator-echarts-website for more details of the building process.

Init

npm install

Dev

npm run dev

Open in browser: http://localhost:3000/echarts-handbook/dist/

Release

# Update contributors
npm run prepare

# Generate to `dist`
npm run generate

Writing

Create a new article

Add .md files under contents/zh/ or contents/en/, and fill in the info in contents/zh/posts.js and contents/en/posts.js.

Reference to Apache ECharts Doc

Do it like this:

xxxx [series.encode](${optionPath}#series.encode) xxxx

Note: if you want it to work in development environment, you may need to edit the config file configs/config.dev.js: make the value of optionPath point to a running environment of incubator-echarts-doc.

Reference to an example

Suppose area-basic is one of the example names in incubator-echarts-examples.

Just add a link of the example:

[this case](${exampleEditorPath}area-basic&edit=1&reset=1)

Embed the live example into the page:

<iframe width="600" height="300" src="${exampleViewPath}area-basic&edit=1&reset=1"></iframe>

Note: if you want it to work in development environment, you may need to edit the config file configs/config.dev.js: make the value of exampleViewPath and exampleEditorPath point to a running environment of incubator-echarts-examples.