commit | 29d0e253a50735d4acd2fc5b3f6cf65d7a38227e | [log] [tgz] |
---|---|---|
author | Wenli Zhang <zwl.sjtu@gmail.com> | Wed Feb 21 09:48:52 2024 +0800 |
committer | GitHub <noreply@github.com> | Wed Feb 21 09:48:52 2024 +0800 |
tree | e116ab6be4c8e03b2d96fc6fe6202d1262b1c6cf | |
parent | 62d1f0bd4fd57028a7c5264d2301765d85efd5bb [diff] | |
parent | 9f24fe240e08f74d336b2d7b246b2a1551c35fb2 [diff] |
Merge pull request #384 from apache/dev-5.5.0 doc: add doc for 5.5.0 pull requets
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.