mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-15 20:20:10 +02:00
chore: Add @mermaid-js/tiny
package
This commit is contained in:
37
packages/tiny/README.md
Normal file
37
packages/tiny/README.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Tiny Mermaid
|
||||
|
||||
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.
|
||||
|
||||
## Usage via NPM
|
||||
|
||||
This package is not meant to be installed directly from npm. It is designed to be used via CDN.
|
||||
If you need to use mermaid in your project, please install the full [`mermaid` package](https://www.npmjs.com/package/mermaid) instead.
|
||||
|
||||
## Removals from mermaid
|
||||
|
||||
This does not support
|
||||
|
||||
- Mindmap Diagram
|
||||
- Architecture Diagram
|
||||
- Katex rendering
|
||||
|
||||
## Usage via CDN
|
||||
|
||||
### Latest version
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny/dist/mermaid.tiny.js"></script>
|
||||
```
|
||||
|
||||
### Specific version
|
||||
|
||||
```html
|
||||
<!-- Format -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@<MERMAID_MAJOR_VERSION>/dist/mermaid.tiny.js"></script>
|
||||
|
||||
<!-- Pinning major version -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11/dist/mermaid.tiny.js"></script>
|
||||
|
||||
<!-- Pinning specific version -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/@mermaid-js/tiny@11.6.0/dist/mermaid.tiny.js"></script>
|
||||
```
|
Reference in New Issue
Block a user