Merge pull request #5124 from mermaid-js/verbiage-updates

Docs: Ecosystem section pages - verbiage updates

.lintstagedrc.mjs

@@ -6,6 +6,6 @@ export default {
     // https://prettier.io/docs/en/cli.html#--cache
     'prettier --write',
   ],
-  'cSpell.json': ['ts-node-esm scripts/fixCSpell.ts'],
+  'cSpell.json': ['tsx scripts/fixCSpell.ts'],
   '**/*.jison': ['pnpm -w run lint:jison'],
 };

.vscode/launch.json

@@ -18,7 +18,8 @@
       "type": "node",
       "request": "launch",
       "args": ["scripts/docs.cli.mts"],
-      "runtimeArgs": ["--loader", "ts-node/esm"],
+      // we'll need to change this to --import in Node.JS v20.6.0 and up
+      "runtimeArgs": ["--loader", "tsx/esm"],
       "cwd": "${workspaceRoot}/packages/mermaid",
       "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
       "smartStep": true,

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
 
@@ -226,5 +236,4 @@ Communication tools and platforms
 - [ExDoc](https://github.com/elixir-lang/ex_doc)
   - [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs)
 - [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io)
-  - [ui.mermaid(...)](https://nicegui.io/reference#mermaid_diagrams)
-  - [ui.markdown(..., extras=\['mermaid'\])](https://nicegui.io/reference#markdown_element)
+  - [ui.mermaid](https://nicegui.io/documentation/mermaid#mermaid_diagrams) ✅

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://docs.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
 

package.json

@@ -15,26 +15,26 @@
     "git graph"
   ],
   "scripts": {
-    "build:vite": "ts-node-esm --transpileOnly .vite/build.ts",
+    "build:vite": "tsx .vite/build.ts",
     "build:mermaid": "pnpm build:vite --mermaid",
     "build:viz": "pnpm build:mermaid --visualize",
     "build:types": "tsc -p ./packages/mermaid/tsconfig.json --emitDeclarationOnly && tsc -p ./packages/mermaid-zenuml/tsconfig.json --emitDeclarationOnly && tsc -p ./packages/mermaid-example-diagram/tsconfig.json --emitDeclarationOnly",
     "build:types:watch": "tsc -p ./packages/mermaid/tsconfig.json --emitDeclarationOnly --watch",
     "build:watch": "pnpm build:vite --watch",
     "build": "pnpm run -r clean && pnpm build:types && pnpm build:vite",
-    "dev": "concurrently \"pnpm build:vite --watch\" \"ts-node-esm .vite/server.ts\"",
+    "dev": "concurrently \"pnpm build:vite --watch\" \"tsx .vite/server.ts\"",
     "dev:coverage": "pnpm coverage:cypress:clean && VITE_COVERAGE=true pnpm dev",
     "release": "pnpm build",
     "lint": "eslint --cache --cache-strategy content --ignore-path .gitignore . && pnpm lint:jison && prettier --cache --check .",
-    "lint:fix": "eslint --cache --cache-strategy content --fix --ignore-path .gitignore . && prettier --write . && ts-node-esm scripts/fixCSpell.ts",
-    "lint:jison": "ts-node-esm ./scripts/jison/lint.mts",
-    "contributors": "ts-node-esm scripts/updateContributors.ts",
+    "lint:fix": "eslint --cache --cache-strategy content --fix --ignore-path .gitignore . && prettier --write . && tsx scripts/fixCSpell.ts",
+    "lint:jison": "tsx ./scripts/jison/lint.mts",
+    "contributors": "tsx scripts/updateContributors.ts",
     "cypress": "cypress run",
     "cypress:open": "cypress open",
     "e2e": "start-server-and-test dev http://localhost:9000/ cypress",
     "coverage:cypress:clean": "rimraf .nyc_output coverage/cypress",
     "e2e:coverage": "pnpm coverage:cypress:clean && VITE_COVERAGE=true pnpm e2e",
-    "coverage:merge": "ts-node-esm scripts/coverage.ts",
+    "coverage:merge": "tsx scripts/coverage.ts",
     "coverage": "pnpm test:coverage --run && pnpm e2e:coverage && pnpm coverage:merge",
     "ci": "vitest run",
     "test": "pnpm lint && vitest run",
@@ -116,7 +116,7 @@
     "rimraf": "^5.0.0",
     "rollup-plugin-visualizer": "^5.9.2",
     "start-server-and-test": "^2.0.0",
-    "ts-node": "^10.9.1",
+    "tsx": "^4.6.2",
     "typescript": "^5.1.3",
     "vite": "^4.3.9",
     "vite-plugin-istanbul": "^4.1.0",

packages/mermaid/package.json

@@ -26,18 +26,18 @@
     "clean": "rimraf dist",
     "dev": "pnpm -w dev",
     "docs:code": "typedoc src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup",
-    "docs:build": "rimraf ../../docs && pnpm docs:spellcheck && pnpm docs:code && ts-node-esm scripts/docs.cli.mts",
-    "docs:verify": "pnpm docs:spellcheck && pnpm docs:code && ts-node-esm scripts/docs.cli.mts --verify",
-    "docs:pre:vitepress": "pnpm --filter ./src/docs prefetch && rimraf src/vitepress && pnpm docs:code && ts-node-esm scripts/docs.cli.mts --vitepress && pnpm --filter ./src/vitepress install --no-frozen-lockfile --ignore-scripts",
+    "docs:build": "rimraf ../../docs && pnpm docs:spellcheck && pnpm docs:code && tsx scripts/docs.cli.mts",
+    "docs:verify": "pnpm docs:spellcheck && pnpm docs:code && tsx scripts/docs.cli.mts --verify",
+    "docs:pre:vitepress": "pnpm --filter ./src/docs prefetch && rimraf src/vitepress && pnpm docs:code && tsx scripts/docs.cli.mts --vitepress && pnpm --filter ./src/vitepress install --no-frozen-lockfile --ignore-scripts",
     "docs:build:vitepress": "pnpm docs:pre:vitepress && (cd src/vitepress && pnpm run build) && cpy --flat src/docs/landing/ ./src/vitepress/.vitepress/dist/landing",
-    "docs:dev": "pnpm docs:pre:vitepress && concurrently \"pnpm --filter ./src/vitepress dev\" \"ts-node-esm scripts/docs.cli.mts --watch --vitepress\"",
-    "docs:dev:docker": "pnpm docs:pre:vitepress && concurrently \"pnpm --filter ./src/vitepress dev:docker\" \"ts-node-esm scripts/docs.cli.mts --watch --vitepress\"",
+    "docs:dev": "pnpm docs:pre:vitepress && concurrently \"pnpm --filter ./src/vitepress dev\" \"tsx scripts/docs.cli.mts --watch --vitepress\"",
+    "docs:dev:docker": "pnpm docs:pre:vitepress && concurrently \"pnpm --filter ./src/vitepress dev:docker\" \"tsx scripts/docs.cli.mts --watch --vitepress\"",
     "docs:serve": "pnpm docs:build:vitepress && vitepress serve src/vitepress",
     "docs:spellcheck": "cspell --config ../../cSpell.json \"src/docs/**/*.md\"",
-    "docs:release-version": "ts-node-esm scripts/update-release-version.mts",
-    "docs:verify-version": "ts-node-esm scripts/update-release-version.mts --verify",
-    "types:build-config": "ts-node-esm --transpileOnly scripts/create-types-from-json-schema.mts",
-    "types:verify-config": "ts-node-esm scripts/create-types-from-json-schema.mts --verify",
+    "docs:release-version": "tsx scripts/update-release-version.mts",
+    "docs:verify-version": "tsx scripts/update-release-version.mts --verify",
+    "types:build-config": "tsx scripts/create-types-from-json-schema.mts",
+    "types:verify-config": "tsx scripts/create-types-from-json-schema.mts --verify",
     "checkCircle": "npx madge --circular ./src",
     "release": "pnpm build",
     "prepublishOnly": "cpy '../../README.*' ./ --cwd=. && pnpm docs:release-version && pnpm -w run build"

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
 
@@ -224,5 +235,4 @@ Communication tools and platforms
 - [ExDoc](https://github.com/elixir-lang/ex_doc)
   - [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs)
 - [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io)
-  - [ui.mermaid(...)](https://nicegui.io/reference#mermaid_diagrams)
-  - [ui.markdown(..., extras=['mermaid'])](https://nicegui.io/reference#markdown_element)
+  - [ui.mermaid](https://nicegui.io/documentation/mermaid#mermaid_diagrams) ✅

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://docs.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
 

packages/mermaid/src/docs/package.json

@@ -11,8 +11,8 @@
     "preview-https": "pnpm build && serve .vitepress/dist",
     "preview-https-no-prefetch": "pnpm build-no-prefetch && serve .vitepress/dist",
     "prefetch": "pnpm fetch-contributors && pnpm fetch-avatars",
-    "fetch-avatars": "ts-node-esm .vitepress/scripts/fetch-avatars.ts",
-    "fetch-contributors": "ts-node-esm .vitepress/scripts/fetch-contributors.ts"
+    "fetch-avatars": "tsx .vitepress/scripts/fetch-avatars.ts",
+    "fetch-contributors": "tsx .vitepress/scripts/fetch-contributors.ts"
   },
   "dependencies": {
     "@vueuse/core": "^10.1.0",