Merge branch 'develop' into sidv/fixDetectorOrder

* develop:
  Update docs
  fix Lint
  Update CHANGELOG.md
  Update CHANGELOG.md
  fix: fix exports
  Doc (typo): remove duplicate "be"
  Fix readme link
  Regenerate mermaid docs
  Add deepdwn to cspell
  Add Deepdwn to native integrations list
This commit is contained in:
Sidharth Vinod
2023-02-24 17:27:47 +05:30
9 changed files with 27 additions and 6 deletions

View File

@@ -2,6 +2,24 @@
## [10.0.0](https://github.com/mermaid-js/mermaid/releases/tag/v10.0.0) ## [10.0.0](https://github.com/mermaid-js/mermaid/releases/tag/v10.0.0)
### Mermaid is ESM only!
We've dropped CJS support. So, you will have to update your import scripts as follows.
```html
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
mermaid.initialize({ startOnLoad: true });
</script>
```
You can keep using v9 by adding the `@9` in the CDN URL.
```diff
- <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.js"></script>
+ <script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.js"></script>
```
### mermaid.render is async and doesn't accept callbacks ### mermaid.render is async and doesn't accept callbacks
```js ```js

View File

@@ -8,7 +8,7 @@ Mermaid
Generate diagrams from markdown-like text. Generate diagrams from markdown-like text.
<p> <p>
<p align="center"> <p align="center">
<a href="https://www.npmjs.com/package/vitest"><img src="https://img.shields.io/npm/v/mermaid?color=ff3670&label="></a> <a href="https://www.npmjs.com/package/mermaid"><img src="https://img.shields.io/npm/v/mermaid?color=ff3670&label="></a>
<p> <p>
<p align="center"> <p align="center">

View File

@@ -8,7 +8,7 @@ Mermaid
通过解析类 Markdown 的文本语法来实现图表的创建和动态修改。 通过解析类 Markdown 的文本语法来实现图表的创建和动态修改。
<p> <p>
<p align="center"> <p align="center">
<a href="https://www.npmjs.com/package/vitest"><img src="https://img.shields.io/npm/v/mermaid?color=ff3670&label="></a> <a href="https://www.npmjs.com/package/mermaid"><img src="https://img.shields.io/npm/v/mermaid?color=ff3670&label="></a>
<p> <p>
<p align="center"> <p align="center">

View File

@@ -27,6 +27,7 @@
"cuzon", "cuzon",
"cytoscape", "cytoscape",
"dagre", "dagre",
"deepdwn",
"descr", "descr",
"docsify", "docsify",
"docsy", "docsy",

View File

@@ -20,6 +20,7 @@ They also serve as proof of concept, for the variety of things that can be built
- [Gitea](https://gitea.io) (**Native support**) - [Gitea](https://gitea.io) (**Native support**)
- [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**) - [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**)
- [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) - [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**)
- [Deepdwn](https://billiam.itch.io/deepdwn) (**Native support**)
- [Joplin](https://joplinapp.org) (**Native support**) - [Joplin](https://joplinapp.org) (**Native support**)
- [Swimm](https://swimm.io) (**Native support**) - [Swimm](https://swimm.io) (**Native support**)
- [Notion](https://notion.so) (**Native support**) - [Notion](https://notion.so) (**Native support**)

View File

@@ -595,7 +595,7 @@ It is possible to get a sequence number attached to each arrow in a sequence dia
</script> </script>
``` ```
It can also be be turned on via the diagram code as in the diagram: It can also be turned on via the diagram code as in the diagram:
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram

View File

@@ -7,8 +7,8 @@
"types": "./dist/mermaid.d.ts", "types": "./dist/mermaid.d.ts",
"exports": { "exports": {
".": { ".": {
"import": "./dist/mermaid.core.mjs", "types": "./dist/mermaid.d.ts",
"types": "./dist/mermaid.d.ts" "import": "./dist/mermaid.core.mjs"
}, },
"./*": "./*" "./*": "./*"
}, },

View File

@@ -14,6 +14,7 @@ They also serve as proof of concept, for the variety of things that can be built
- [Gitea](https://gitea.io) (**Native support**) - [Gitea](https://gitea.io) (**Native support**)
- [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**) - [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**)
- [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) - [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**)
- [Deepdwn](https://billiam.itch.io/deepdwn) (**Native support**)
- [Joplin](https://joplinapp.org) (**Native support**) - [Joplin](https://joplinapp.org) (**Native support**)
- [Swimm](https://swimm.io) (**Native support**) - [Swimm](https://swimm.io) (**Native support**)
- [Notion](https://notion.so) (**Native support**) - [Notion](https://notion.so) (**Native support**)

View File

@@ -418,7 +418,7 @@ It is possible to get a sequence number attached to each arrow in a sequence dia
</script> </script>
``` ```
It can also be be turned on via the diagram code as in the diagram: It can also be turned on via the diagram code as in the diagram:
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram