This is an automated email from the ASF dual-hosted git repository.
ovilia pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/echarts-from-mermaid.git
The following commit(s) were added to refs/heads/main by this push:
new 40dfc44 doc: update doc
40dfc44 is described below
commit 40dfc4433c9847b5d4a0e2f6101242a986f6dbff
Author: Ovilia <[email protected]>
AuthorDate: Thu Mar 20 17:17:42 2025 +0800
doc: update doc
---
README.md | 9 +--------
1 file changed, 1 insertion(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6e9b0d8..88cabbd 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
# Apache ECharts From Mermaid
-> ⚠️⚠️⚠️ **Note:** This project is still under development and should not be
used in production.
-
A plugin that enables Apache ECharts to render charts using Mermaid-like
syntax.
This plugin is particularly useful when you want to generate charts from
text/markdown, especially in LLM applications. Instead of having LLMs generate
complex ECharts options directly, you can use this plugin to convert simpler
Mermaid-like syntax into ECharts options. This approach is more reliable since
Mermaid syntax is much simpler than ECharts' option structure.
@@ -49,13 +47,8 @@ chart.setOption(option);
Note that the supported charts are neither a subset nor a superset of the
charts supported by Mermaid. This plugin is designed to generate ECharts
Options in a syntax that is inspired by Mermaid.
-### Mermaid
-
- Pie (`pie`)
- Bar (`xychart-beta`, or simplified as `xychart`)
- Line (`xychart-beta`, or simplified as `xychart`)
-- Sankey (`sankey-beta`)
-
-### Extended
-Mermaid doesn't support the following types, but we used Mermaid-like syntax
to describe these types supported by Apache ECharts.
+More chart types will be supported in the future.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
