Official repository of Apache ECharts documentation
APACHE-2.0 License
This project is part of the source of The Apache ECharts Official Website. See echarts-website for more details of the building process.
Do not need other project.
npm run dev
It will:
For example: Embed a example in doc:
~[700x300](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)
Provide a example link in doc:
[vertically scrollable legend](${galleryEditorPath}pie-legend&edit=1&reset=1)
Provide a website link in doc:
[Apache ECharts website](${websitePath}/en/download.html)
A ~
can be used to refer to a option item in the same doc. For example:
[xAxis.name](~xAxis.name)
If intending to reference an anchor in different doc, it can be:
[itemStyle](option.html#series.itemStyle)
// Good
Some description
{{ use: partial-xxx }}
Some other description
// Bad
Some description about {{ use: partial-inline-xxx }}
// Good
{{ if: ${prefix} !== '#' }}
{{ else }}
{{ /if }}
0 ~ 1
// Bad
{{ if: ${prefix} !== '#' }}{{ else }}{{ /if }} 0 ~ 1
// Good
{{ if: ${prefix} !== '#' }}
It indicates the range of saturation (color alpha) for nodes in a level.
{{ else }}
It indicates the range of saturation (color alpha) for nodes of the series.
{{ /if }}
The range of values is 0 ~ 1.
// Bad
It indicates the range of saturation (color alpha) {{ if: ${prefix} !== '#' }}for nodes in a level {{ else }} of the series{{ /if }}. The range of values is 0 ~ 1.
Option docs needs to be formatted before commit.
Run
npm run format
Make sure have a double review on the git diff after formatted.
After you finished editing doc of one language. You can use following script to sync it to another language.
# zh to en
node tool/patchLanguage --from=zh --to=en
# en to zh
node tool/patchLanguage --from=en --to=zh
Sync will move the structure. It will make editing of other languages much easier.
Again make sure have a double review on the git diff after syncing.