1
- # rehype-mermaidjs
1
+ # rehype-mermaid
2
2
3
- [ ![ github actions] ( https://github.com/remcohaszing/rehype-mermaidjs /actions/workflows/ci.yaml/badge.svg )] ( https://github.com/remcohaszing/rehype-mermaidjs /actions/workflows/ci.yaml )
4
- [ ![ codecov] ( https://codecov.io/gh/remcohaszing/rehype-mermaidjs /branch/main/graph/badge.svg )] ( https://codecov.io/gh/remcohaszing/rehype-mermaidjs )
5
- [ ![ npm version] ( https://img.shields.io/npm/v/rehype-mermaidjs )] ( https://www.npmjs.com/package/rehype-mermaidjs )
6
- [ ![ npm downloads] ( https://img.shields.io/npm/dm/rehype-mermaidjs )] ( https://www.npmjs.com/package/rehype-mermaidjs )
3
+ [ ![ github actions] ( https://github.com/remcohaszing/rehype-mermaid /actions/workflows/ci.yaml/badge.svg )] ( https://github.com/remcohaszing/rehype-mermaid /actions/workflows/ci.yaml )
4
+ [ ![ codecov] ( https://codecov.io/gh/remcohaszing/rehype-mermaid /branch/main/graph/badge.svg )] ( https://codecov.io/gh/remcohaszing/rehype-mermaid )
5
+ [ ![ npm version] ( https://img.shields.io/npm/v/rehype-mermaid )] ( https://www.npmjs.com/package/rehype-mermaid )
6
+ [ ![ npm downloads] ( https://img.shields.io/npm/dm/rehype-mermaid )] ( https://www.npmjs.com/package/rehype-mermaid )
7
7
8
8
A [ rehype] ( https://rehype.js.org ) plugin to render [ mermaid] ( https://mermaid-js.github.io ) diagrams.
9
9
@@ -28,12 +28,13 @@ A [rehype](https://rehype.js.org) plugin to render [mermaid](https://mermaid-js.
28
28
- [ Compatibility] ( #compatibility )
29
29
- [ Related Projects] ( #related-projects )
30
30
- [ Contributing] ( #contributing )
31
+ - [ Acknowledgements] ( #acknowledgements )
31
32
- [ License] ( #license )
32
33
33
34
## Installation
34
35
35
36
``` sh
36
- npm install rehype-mermaidjs
37
+ npm install rehype-mermaid
37
38
```
38
39
39
40
In Node.js this package uses [ playwright] ( https://playwright.dev ) under the hood. To use it, you may
@@ -88,7 +89,7 @@ The following script:
88
89
import { readFile } from ' node:fs/promises'
89
90
90
91
import { rehype } from ' rehype'
91
- import rehypeMermaid from ' rehype-mermaidjs '
92
+ import rehypeMermaid from ' rehype-mermaid '
92
93
93
94
const { value } = await rehype ()
94
95
.use (rehypeMermaid, {
@@ -267,6 +268,10 @@ slightly different results. Don’t worry about adding new fixtures, but don’t
267
268
that cause CI to fail. Furthermore see my global
268
269
[ contributing guidelines] ( https://github.com/remcohaszing/.github/blob/main/CONTRIBUTING.md ) .
269
270
271
+ ## Acknowledgements
272
+
273
+ Thanks to [ @bitekong ] ( https://github.com/bitekong ) for giving me the npm package name.
274
+
270
275
## License
271
276
272
277
[ MIT] ( LICENSE.md ) © [ Remco Haszing] ( https://github.com/remcohaszing )
0 commit comments