@mermaid-js/tiny 11.6.1 → 11.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
  This is a tiny version of mermaid that is optimized for the web. It is a subset of the mermaid library and is designed to be used in the browser via CDN.
4
4
 
5
- ## Usage via NPM
5
+ ## Lazy loading
6
6
 
7
- This package is not meant to be installed directly from npm. It is designed to be used via CDN.
8
- If you need to use mermaid in your project, please install the full [`mermaid` package](https://www.npmjs.com/package/mermaid) instead.
7
+ The original mermaid library supports lazy loading, so it will be faster on the initial load, and only load the required diagrams.
8
+ This is not supported in the tiny mermaid library. So it's always recommended to use the full mermaid library unless you have a very specific reason to reduce the bundle size.
9
9
 
10
10
  ## Removals from mermaid
11
11
 
@@ -14,16 +14,14 @@ This does not support
14
14
  - Mindmap Diagram
15
15
  - Architecture Diagram
16
16
  - Katex rendering
17
+ - Lazy loading
17
18
 
18
- ## Usage via CDN
19
-
20
- ### Latest version
19
+ ## Usage via NPM
21
20
 
22
- ```html
23
- <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny/dist/mermaid.tiny.js"></script>
24
- ```
21
+ This package is not meant to be installed directly from npm. It is designed to be used via CDN.
22
+ If you need to use mermaid in your project, please install the full [`mermaid` package](https://www.npmjs.com/package/mermaid) instead.
25
23
 
26
- ### Specific version
24
+ ## Usage via CDN
27
25
 
28
26
  ```html
29
27
  <!-- Format -->