Thanks Dave! I think "echarts-for-markdown" should be a good name.
The problem with ```echarts is that most AIs don't know about this syntax unless the developer gives an example in the prompt, but this should be acceptable I guess. Thanks *Ovilia* On Mon, Mar 24, 2025 at 11:35 PM Dave Fisher <w...@apache.org> wrote: > Hi - > > Since this is an approach that is similar to how mermaid charts are > specified in text / markdown then I don’t think that the word “mermaid” > needs to be used. This will lead to confusion. I was confused thinking that > somehow this might solve a current issue in mermaid in that it has no > consistent way that I have found to embed mermaid in a webpage. Instead > this effort is all about putting something like the following in markdown > text: > > ```echarts > …. > ``` > > I think that “echarts-for-markdown” or “echarts-text-embedded” might be > better descriptions of what this plugin does. > > Best, > Dave > > > On Mar 24, 2025, at 1:41 AM, Ovilia <oviliazh...@gmail.com> wrote: > > > > Thanks Dave for the information. > > > > Sure, let's discuss a better name. > > > > “echarts-mermaid-plugin” might not be accurate because it doesn't have > much > > to do with mermaid, other than the API is inspired by mermaid. > > How about "echarts-mermaiddish" to imply it's kind like mermaid? > > > > Thanks > > > > *Ovilia* > > > > > > On Thu, Mar 20, 2025 at 10:54 PM Dave Fisher <w...@apache.org> wrote: > > > >> > >> > >>> On Mar 20, 2025, at 2:22 AM, Ovilia <oviliazh...@gmail.com> wrote: > >>> > >>> Hi, > >>> > >>> I've developed pie/line/bar chart options for now. > >>> Check out to learn more at > >> https://github.com/apache/echarts-from-mermaid. > >>> > >>> I would like to rename this repo into "mermaid-inspired-echarts" > instead > >> of > >>> the current name because it's a great detail of job to make sure it > >> behaves > >>> exactly the way as with mermaid and ECharts doesn't support a lot of > >> graphs > >>> that mermaid supports. > >> > >> Repository names are required to be in the format of `apache/echarts-*`. > >> This is necessary for permissions to be properly assigned. > >> > >>> > >>> Does this sound like a good name, or any other suggestions? Does anyone > >>> know how to change the GitHub repo name? I guess opening a jira ticket > >>> should do, right? > >> > >> Yes, but it will be rejected if the name is disallowed. Let’s find a > >> better name. > >> > >> Is “echarts-mermaid-plugin” good? > >> > >> Best, > >> Dave > >> > >> > >>> > >>> Thanks > >>> > >>> *Ovilia* > >>> > >>> > >>> On Tue, Feb 18, 2025 at 5:46 PM Ovilia <oviliazh...@gmail.com> wrote: > >>> > >>>> Dear all, > >>>> Considering that we plan to release ECharts 6.0 at the end of March > and > >>>> there are still some functions under development, the ECharts From > >> Mermaid > >>>> Project is very likely not to be supported in version 6.0. We expect > to > >>>> support it in the subsequent versions (such as 6.1.0). If you are > >>>> interested in this project or have any suggestions, you are welcome to > >>>> continue the discussion. > >>>> Best regards! > >>>> > >>>> Thanks > >>>> > >>>> *Ovilia* > >>>> > >>>> > >>>> On Thu, Feb 6, 2025 at 5:39 PM Ovilia <oviliazh...@gmail.com> wrote: > >>>> > >>>>> And here is the link to the project: > >>>>> https://github.com/apache/echarts-from-mermaid > >>>>> > >>>>> Thanks > >>>>> > >>>>> *Ovilia* > >>>>> > >>>>> > >>>>> On Thu, Feb 6, 2025 at 5:37 PM Ovilia <oviliazh...@gmail.com> wrote: > >>>>> > >>>>>> Dear Apache ECharts Developers, > >>>>>> > >>>>>> I hope this message finds you well. > >>>>>> > >>>>>> I am writing to introduce a new project currently under development, > >>>>>> called "Apache ECharts From Mermaid." This project aims to enable > >> Apache > >>>>>> ECharts to render charts using a Mermaid-like syntax. By leveraging > >> this > >>>>>> plugin, we can generate charts from text or markdown, which is > >> especially > >>>>>> beneficial in LLM applications. > >>>>>> > >>>>>> The primary advantage of this approach lies in the simplicity of > >> Mermaid > >>>>>> syntax compared to the complex structure of ECharts options. This > >> makes the > >>>>>> chart generation process more reliable and user-friendly. > >> Additionally, > >>>>>> users can customize the appearance of charts using > >> `echarts.registerTheme`. > >>>>>> > >>>>>> Here is a brief example of how it works: > >>>>>> > >>>>>> ```javascript > >>>>>> import { EChartsFromMermaid } from 'echarts-from-mermaid'; > >>>>>> import * as echarts from 'echarts'; > >>>>>> > >>>>>> const mermaidDefinition = ` > >>>>>> pie title Pets adopted by volunteers > >>>>>> "Dogs" : 386 > >>>>>> "Cats" : 85 > >>>>>> "Rats" : 15 > >>>>>> `; > >>>>>> > >>>>>> const option = EChartsFromMermaid.getOption(mermaidDefinition); > >>>>>> /** which generates the following option: > >>>>>> * { > >>>>>> * title: { > >>>>>> * text: 'Pets adopted by volunteers' > >>>>>> * }, > >>>>>> * series: [ > >>>>>> * { > >>>>>> * type: 'pie', > >>>>>> * data: [ > >>>>>> * { value: 386, name: 'Dogs' }, > >>>>>> * { value: 85, name: 'Cats' }, > >>>>>> * { value: 15, name: 'Rats' } > >>>>>> * ] > >>>>>> * } > >>>>>> * ] > >>>>>> * } > >>>>>> */ > >>>>>> > >>>>>> // This option can be used directly with ECharts. > >>>>>> const chart = echarts.init(document.getElementById('main')); > >>>>>> chart.setOption(option); > >>>>>> > >>>>>> Currently, the plugin supports several chart types such as pie, bar, > >>>>>> line, and sankey. We have also extended Mermaid's capability to > >> describe > >>>>>> other chart types supported by Apache ECharts. > >>>>>> > >>>>>> As this project is still in its development phase, we would greatly > >>>>>> appreciate your feedback and suggestions to enhance it further. Your > >> input > >>>>>> will be invaluable in ensuring that we create a robust and versatile > >> tool. > >>>>>> > >>>>>> There are types supported by Mermaid like Pie, Bar, Line, and > Sankey. > >>>>>> And I also plan to extend the Mermaid - like syntax to describe some > >> chart > >>>>>> types that Mermaid doesn't support natively but are supported by > >> Apache > >>>>>> ECharts. > >>>>>> > >>>>>> I would greatly appreciate it if you could take a look at the > project > >>>>>> and share your thoughts, suggestions, or any potential improvements. > >> Your > >>>>>> insights would be extremely valuable as we continue to develop this > >> plugin. > >>>>>> > >>>>>> Thank you for your time and consideration. I look forward to hearing > >>>>>> your thoughts. > >>>>>> > >>>>>> Best regards, > >>>>>> > >>>>>> *Ovilia* > >>>>>> > >>>>> > >> > >> > >> --------------------------------------------------------------------- > >> To unsubscribe, e-mail: dev-unsubscr...@echarts.apache.org > >> For additional commands, e-mail: dev-h...@echarts.apache.org > >> > >> > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@echarts.apache.org > For additional commands, e-mail: dev-h...@echarts.apache.org > >
