Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remcohaszing/remark-mermaidjs
A remark plugin to render mermaid diagrams using playwright
https://github.com/remcohaszing/remark-mermaidjs
javascript mermaid remark typescript unified
Last synced: 6 days ago
JSON representation
A remark plugin to render mermaid diagrams using playwright
- Host: GitHub
- URL: https://github.com/remcohaszing/remark-mermaidjs
- Owner: remcohaszing
- License: mit
- Created: 2021-02-17T16:56:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T19:11:33.000Z (3 months ago)
- Last Synced: 2024-12-21T00:07:42.295Z (13 days ago)
- Topics: javascript, mermaid, remark, typescript, unified
- Language: HTML
- Homepage:
- Size: 1.99 MB
- Stars: 71
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# remark-mermaidjs
[](https://github.com/remcohaszing/remark-mermaidjs/actions/workflows/ci.yaml)
[](https://codecov.io/gh/remcohaszing/remark-mermaidjs)
[](https://www.npmjs.com/package/remark-mermaidjs)
[](https://www.npmjs.com/package/remark-mermaidjs)
A [remark](https://remark.js.org) plugin to render [mermaid](https://mermaid-js.github.io) diagrams
using [playwright](https://playwright.dev).
> \[!IMPORTANT]
>
> Use cases for this package are rare. You should probably use
> [`rehype-mermaid`](https://github.com/remcohaszing/rehype-mermaid) instead.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [`unified().use(remarkMermaid, options?)`](#unifieduseremarkmermaid-options)
- [Compatibility](#compatibility)
- [Related Projects](#related-projects)
- [Contributing](#contributing)
- [License](#license)
## Installation
```sh
npm install remark-mermaidjs
```
Outside of browsers `remark-mermaidjs` uses [Playwright](https://playwright.dev). If you use this
outside of a browser, you need to install Playwright and a Playwright browser.
```sh
npm install playwright
npx playwright install --with-deps chromium
```
See the Playwright [Browsers](https://playwright.dev/docs/browsers) documentation for more
information.
## Usage
This plugin takes all code blocks marked as `mermaid` and renders them as an inline SVG.
```js
import { readFile } from 'node:fs/promises'
import { remark } from 'remark'
import remarkMermaid from 'remark-mermaidjs'
const { value } = await remark()
.use(remarkMermaid, {
/* Options */
})
.process(await readFile('readme.md'))
console.log(value)
```
## API
This package has a default export `remarkMermaid`.
### `unified().use(remarkMermaid, options?)`
#### `browser`
The Playwright browser to use. (`object`, default: chromium)
#### `css`
A URL that points to a custom CSS file to load. Use this to load custom fonts. This option is
ignored in the browser. You need to include the CSS in your build manually. (`string` | `URL`)
#### `errorFallback`
Create a fallback node if processing of a mermaid diagram fails. If nothing is returned, the code
block is removed. The function receives the following arguments:
- `node`: The mdast `code` node that couldn’t be rendered.
- `error`: The error message that was thrown.
- `file`: The file on which the error occurred.
#### `launchOptions`
The options used to launch the browser. (`object`)
- **Note**: This options is required in Node.js. In the browser this option is unused.
#### `mermaidConfig`
The [mermaid config](https://mermaid.js.org/config/schema-docs/config.html) to use.
**Note**: This config is only supported in Node.js. In the browser this option is unused. If you use
this in a browser, call `mermaid.initialize()` manually.
#### `prefix`
A custom prefix to use for Mermaid IDs. (`string`, default: `mermaid`)
## Compatibility
This project is compatible with Node.js 18 or greater.
## Related Projects
- [`mermaid`](https://mermaid.js.org) is the library that’s used to render the diagrams.
- [`mermaid-isomorphic`](https://github.com/remcohaszing/mermaid-isomorphic) allows this package to
render Mermaid diagrams in both Node.js and the browser.
- [`rehype-mermaid`](https://github.com/remcohaszing/rehype-mermaid) is a more powerful plugin that
does the same, but as a [rehype](https://github.com/rehypejs/rehype) plugin.
## Contributing
Test fixtures are generated and verified using Linux. Rendering on other platforms may yield
slightly different results. Don’t worry about adding new fixtures, but don’t update existing ones
that cause CI to fail. Furthermore see my global
[contributing guidelines](https://github.com/remcohaszing/.github/blob/main/CONTRIBUTING.md).
## License
[MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)