From f363af482e1b0ccc2abf7db3a808b2398aac7010 Mon Sep 17 00:00:00 2001 From: Steph <35910788+huynhicode@users.noreply.github.com> Date: Thu, 7 Dec 2023 10:14:33 -0800 Subject: [PATCH] verbiage updates --- docs/ecosystem/integrations-community.md | 24 ++++++++++++------ docs/ecosystem/mermaid-chart.md | 13 +++++++--- .../docs/ecosystem/integrations-community.md | 25 +++++++++++++------ .../src/docs/ecosystem/mermaid-chart.md | 13 +++++++--- 4 files changed, 55 insertions(+), 20 deletions(-) diff --git a/docs/ecosystem/integrations-community.md b/docs/ecosystem/integrations-community.md index 00d482fee9..6d41d02c02 100644 --- a/docs/ecosystem/integrations-community.md +++ b/docs/ecosystem/integrations-community.md @@ -6,17 +6,26 @@ # Integrations -## Official integration: [Mermaid Chart](./mermaid-chart.md) +## Official integration -We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created with Mermaid. +### Mermaid Chart + +Mermaid Chart is built by the team behind Mermaid JS. + +For more details, visit the [Mermaid Chart page](./mermaid-chart.md), or visit the [Mermaid Chart website](https://www.mermaidchart.com) . ## Community integrations -Below are a list of community plugins and integrations created with Mermaid. +We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created by the community. -### Productivity tools +See the list below of community plugins and integrations created with Mermaid. -✅ = Native support +> **Note** +> A ✅ indicates Native support for Mermaid on the respective platform. + +To add an integration to this list, see the [Integrations - create page](./integrations-create.md). + +### Productivity tools - [GitHub](https://github.com) ✅ - [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) ✅ @@ -187,13 +196,14 @@ Communication tools and platforms - [mkdocs-material](https://github.com/squidfunk/mkdocs-material), check the [docs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/) - [Type Doc](https://typedoc.org/) - [typedoc-plugin-mermaid](https://www.npmjs.com/package/typedoc-plugin-mermaid) -- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) (native support in theme) +- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) ✅ - [Codedoc](https://codedoc.cc/) - [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin) - [mdbook](https://rust-lang.github.io/mdBook/index.html) - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) - [Quarto](https://quarto.org/) -- [Typora](https://typora.io/) ([native support](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid)) +- [Typora](https://typora.io/) ✅ + - [See docs](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid) ### Browser Extensions diff --git a/docs/ecosystem/mermaid-chart.md b/docs/ecosystem/mermaid-chart.md index 28c17e9d3f..4162c863c9 100644 --- a/docs/ecosystem/mermaid-chart.md +++ b/docs/ecosystem/mermaid-chart.md @@ -22,9 +22,16 @@ - **Collaboration** - A web based collaboration feature for multi-user editing on Mermaid diagrams in real-time (Pro plan). -- **Plugins** - A plugin system for extending the functionality of Mermaid. Currently includes [VS Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart) and [ChatGPT](https://www.mermaidchart.com/plugins/chatgpt). +- **Plugins** - A plugin system for extending the functionality of Mermaid. -- **AI** - An AI chatbot that can generate Mermaid diagrams from text (Pro plan). + Plugins are available for: + + - [ChatGPT](https://www.mermaidchart.com/plugins/chatgpt) + - [JetBrains IDE](https://plugins.jetbrains.com/plugin/23043-mermaid-chart) + - [Microsoft PowerPoint and Word](https://appsource.microsoft.com/en-us/product/office/WA200006214?tab=Overview) + - [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart) + +- **AI diagramming** - A feature for generating Mermaid diagrams from text using AI (Pro plan). - **More** - To learn more, visit our [Product](https://www.mermaidchart.com/product) page. @@ -40,7 +47,7 @@ Sign up for a free account at [Mermaid Chart](https://www.mermaidchart.com/app/sign-up). -Mermaid Chart is currently offering a 30-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page. +Mermaid Chart is currently offering a 14-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page. ## Mermaid JS contributions diff --git a/packages/mermaid/src/docs/ecosystem/integrations-community.md b/packages/mermaid/src/docs/ecosystem/integrations-community.md index 6ad8945d32..a42083b255 100644 --- a/packages/mermaid/src/docs/ecosystem/integrations-community.md +++ b/packages/mermaid/src/docs/ecosystem/integrations-community.md @@ -4,17 +4,27 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress # Integrations -## Official integration: [Mermaid Chart](./mermaid-chart.md) +## Official integration -We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created with Mermaid. +### Mermaid Chart + +Mermaid Chart is built by the team behind Mermaid JS. + +For more details, visit the [Mermaid Chart page](./mermaid-chart.md), or visit the [Mermaid Chart website](https://www.mermaidchart.com) . ## Community integrations -Below are a list of community plugins and integrations created with Mermaid. +We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created by the community. -### Productivity tools +See the list below of community plugins and integrations created with Mermaid. -✅ = Native support +```note +A ✅ indicates Native support for Mermaid on the respective platform. +``` + +To add an integration to this list, see the [Integrations - create page](./integrations-create.md). + +### Productivity tools - [GitHub](https://github.com) ✅ - [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) ✅ @@ -185,13 +195,14 @@ Communication tools and platforms - [mkdocs-material](https://github.com/squidfunk/mkdocs-material), check the [docs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/) - [Type Doc](https://typedoc.org/) - [typedoc-plugin-mermaid](https://www.npmjs.com/package/typedoc-plugin-mermaid) -- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) (native support in theme) +- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) ✅ - [Codedoc](https://codedoc.cc/) - [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin) - [mdbook](https://rust-lang.github.io/mdBook/index.html) - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) - [Quarto](https://quarto.org/) -- [Typora](https://typora.io/) ([native support](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid)) +- [Typora](https://typora.io/) ✅ + - [See docs](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid) ### Browser Extensions diff --git a/packages/mermaid/src/docs/ecosystem/mermaid-chart.md b/packages/mermaid/src/docs/ecosystem/mermaid-chart.md index 7d0e90024e..17a4bba9b7 100644 --- a/packages/mermaid/src/docs/ecosystem/mermaid-chart.md +++ b/packages/mermaid/src/docs/ecosystem/mermaid-chart.md @@ -20,9 +20,16 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress - **Collaboration** - A web based collaboration feature for multi-user editing on Mermaid diagrams in real-time (Pro plan). -- **Plugins** - A plugin system for extending the functionality of Mermaid. Currently includes [VS Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart) and [ChatGPT](https://www.mermaidchart.com/plugins/chatgpt). +- **Plugins** - A plugin system for extending the functionality of Mermaid. -- **AI** - An AI chatbot that can generate Mermaid diagrams from text (Pro plan). + Plugins are available for: + + - [ChatGPT](https://www.mermaidchart.com/plugins/chatgpt) + - [JetBrains IDE](https://plugins.jetbrains.com/plugin/23043-mermaid-chart) + - [Microsoft PowerPoint and Word](https://appsource.microsoft.com/en-us/product/office/WA200006214?tab=Overview) + - [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart) + +- **AI diagramming** - A feature for generating Mermaid diagrams from text using AI (Pro plan). - **More** - To learn more, visit our [Product](https://www.mermaidchart.com/product) page. @@ -38,7 +45,7 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress Sign up for a free account at [Mermaid Chart](https://www.mermaidchart.com/app/sign-up). -Mermaid Chart is currently offering a 30-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page. +Mermaid Chart is currently offering a 14-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page. ## Mermaid JS contributions