@mermaid-js/tiny 0.0.1 → 11.6.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
@@ -1,20 +1,37 @@
1
1
  # Tiny Mermaid
2
2
 
3
- This is a tiny version of mermaid that is optimized for the web. It is a subset of the full mermaid library and is designed to be used in the browser.
4
-
5
- ## Usage via CDN
6
-
7
- ```html
8
- <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@latest/dist/mermaid.tiny.js"></script>
9
- ```
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.
10
4
 
11
5
  ## Usage via NPM
12
6
 
13
- Do not install this package. Use the full `mermaid` package instead.
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.
14
9
 
15
10
  ## Removals from mermaid
16
11
 
17
12
  This does not support
18
13
 
19
- - Katex rendering
20
14
  - Mindmap Diagram
15
+ - Architecture Diagram
16
+ - Katex rendering
17
+
18
+ ## Usage via CDN
19
+
20
+ ### Latest version
21
+
22
+ ```html
23
+ <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny/dist/mermaid.tiny.js"></script>
24
+ ```
25
+
26
+ ### Specific version
27
+
28
+ ```html
29
+ <!-- Format -->
30
+ <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@<MERMAID_MAJOR_VERSION>/dist/mermaid.tiny.js"></script>
31
+
32
+ <!-- Pinning major version -->
33
+ <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11/dist/mermaid.tiny.js"></script>
34
+
35
+ <!-- Pinning specific version -->
36
+ <script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11.6.0/dist/mermaid.tiny.js"></script>
37
+ ```