You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by sh...@apache.org on 2020/09/04 07:07:27 UTC
[incubator-echarts-doc] branch next updated: Update README.md
This is an automated email from the ASF dual-hosted git repository.
shenyi pushed a commit to branch next
in repository https://gitbox.apache.org/repos/asf/incubator-echarts-doc.git
The following commit(s) were added to refs/heads/next by this push:
new 2b74343 Update README.md
2b74343 is described below
commit 2b743437eb580a0755a396b4f69c7fe8c025345b
Author: pissang <bm...@gmail.com>
AuthorDate: Fri Sep 4 15:07:15 2020 +0800
Update README.md
---
README.md | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 61f56e5..56531be 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,15 @@ Provide a website link in doc:
[Apache ECharts (incubating) website](${websitePath}/en/download.html)
```
-Notes:
+#### Reference of option
+
+A `~` can be used to refer to a option item in the same doc. For example:
+
+```md
+[xAxis.name](~xAxis.name)
+```
+
+#### Notes:
1. Formatter will treat {{use}} as a block. So don't use it **inline**.
@@ -88,7 +96,7 @@ The range of values is 0 ~ 1.
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.
```
-#### Format Option Docs
+## Format Option Docs
Option docs needs to be formatted before commit.
@@ -99,7 +107,7 @@ npm run format
Make sure have a double review on the git diff after formatted.
-#### Sync docs between different languages.
+## Sync docs between different languages.
After you finished editing doc of one language. You can use following script to sync it to another language.
@@ -113,11 +121,3 @@ 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.
-
-#### Reference of option
-
-A `~` can be used to refer to a option item in the same doc. For example:
-
-```md
-[xAxis.name](~xAxis.name)
-```
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org