| 6dd74de | | | 1 | # Tiny Mermaid |
| 6dd74de | | | 2 | |
| 6dd74de | | | 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. |
| 6dd74de | | | 4 | |
| 6dd74de | | | 5 | ## Lazy loading |
| 6dd74de | | | 6 | |
| 6dd74de | | | 7 | The original mermaid library supports lazy loading, so it will be faster on the initial load, and only load the required diagrams. |
| 6dd74de | | | 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. |
| 6dd74de | | | 9 | |
| 6dd74de | | | 10 | ## Removals from mermaid |
| 6dd74de | | | 11 | |
| 6dd74de | | | 12 | This does not support |
| 6dd74de | | | 13 | |
| 6dd74de | | | 14 | - Mindmap Diagram |
| 6dd74de | | | 15 | - Architecture Diagram |
| 6dd74de | | | 16 | - Katex rendering |
| 6dd74de | | | 17 | - Lazy loading |
| 6dd74de | | | 18 | |
| 6dd74de | | | 19 | ## Usage via NPM |
| 6dd74de | | | 20 | |
| 6dd74de | | | 21 | This package is not meant to be installed directly from npm. It is designed to be used via CDN. |
| 6dd74de | | | 22 | If you need to use mermaid in your project, please install the full [`mermaid` package](https://www.npmjs.com/package/mermaid) instead. |
| 6dd74de | | | 23 | |
| 6dd74de | | | 24 | ## Usage via CDN |
| 6dd74de | | | 25 | |
| 6dd74de | | | 26 | ```html |
| 6dd74de | | | 27 | <!-- Format --> |
| 6dd74de | | | 28 | <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@<MERMAID_MAJOR_VERSION>/dist/mermaid.tiny.js"></script> |
| 6dd74de | | | 29 | |
| 6dd74de | | | 30 | <!-- Pinning major version --> |
| 6dd74de | | | 31 | <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11/dist/mermaid.tiny.js"></script> |
| 6dd74de | | | 32 | |
| 6dd74de | | | 33 | <!-- Pinning specific version --> |
| 6dd74de | | | 34 | <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11.6.0/dist/mermaid.tiny.js"></script> |
| 6dd74de | | | 35 | ``` |