https://github.com/prinorange/remark-embed-plantuml
A remark plugin that allows you render the PlantUML in the markdown document. This package has integrated JRE and it will execute PlantUML callings automatically, it realized out-of-the-box use.
https://github.com/prinorange/remark-embed-plantuml
markdown mdast mdx plantuml remark remark-plugin unified
Last synced: 4 months ago
JSON representation
A remark plugin that allows you render the PlantUML in the markdown document. This package has integrated JRE and it will execute PlantUML callings automatically, it realized out-of-the-box use.
- Host: GitHub
- URL: https://github.com/prinorange/remark-embed-plantuml
- Owner: PrinOrange
- License: mit
- Created: 2025-02-06T07:28:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-08T05:42:47.000Z (over 1 year ago)
- Last Synced: 2025-03-26T01:19:28.967Z (about 1 year ago)
- Topics: markdown, mdast, mdx, plantuml, remark, remark-plugin, unified
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/remark-embed-plantuml
- Size: 10.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Remark Embed PlantUML
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
> ⚠ **NOTE:** This package is in the early stages of development and requires user feedback and further investigation. If you encounter any issues, please [submit an issue](https://github.com/PrinOrange/remark-embed-plantuml/issues).
This is a **Remark** plugin that allows you to embed **PlantUML** diagrams directly in your markdown documents. It scans all **PlantUML** code blocks in the markdown file and converts them into **Base64-encoded** images locally.
PlantUML requires a **Java Runtime Environment (JRE)**, but you do **not** need to install it manually. This package includes an integrated JRE and automatically executes PlantUML commands, making it easy to use out of the box.
> **Note:** Since this package includes a bundled Java JRE and PlantUML JAR file, it is only compatible with a **Node.js** environment. It will not work in **browsers** or **Electron render processes**. Additionally, because building tools like **Webpack** and **Vite** cannot recognize Java binaries, this package will not function properly if bundled into a project. That means you can not use this in Next.js client-side code or other most of frontend integration frameworks as far. But we are trying to work out this problem now.
## Installation
Install this package using npm:
```bash
npm install remark-embed-plantuml
```
## Usage
Consider the following markdown file:
```plaintext
# Hello, PlantUML
Here is a simple PlantUML diagram:
\`\`\`plantuml
@startuml
Alice -> Bob: test
@enduml
\`\`\`
```
Now, integrate this plugin into your code:
```javascript
import remarkEmbedPlantUml from 'remark-embed-plantuml';
import remarkParse from 'remark-parse';
import remarkStringify from 'remark-stringify';
import {unified} from 'unified';
import {readFile} from 'node:fs/promises';
(async () => {
const processor = unified()
.use(remarkParse)
.use(remarkEmbedPlantUml, {format: 'png', stdrpt: 2, darkmode: true})
.use(remarkStringify);
const transformed = await processor.process(await readFile('doc.md'));
console.log(transformed.toString());
})();
```
### Output:
```markdown
# Hello, PlantUML
Here is a simple PlantUML diagram:
```
## API
This package is **ESM-only** and provides a default export: `remarkEmbedPlantUML`. You can integrate it with **unified.js**.
### `unified().use(remarkEmbedPlantUML, options?)`
This plugin supports [PlantUML command-line arguments](https://plantuml.com/en/command-line) and executes **PlantUML** via a CLI pipe.
### Options
#### `format?: 'png' | 'svg'`
Specifies the output format. Defaults to `'png'`. Only `'svg'` and `'png'` are supported. The result is embedded as a **Base64-encoded** image.
#### `theme?: string`
Specifies the **theme** for the diagram. See the [official theme documentation](https://plantuml.com/en/theme) for available options.
#### `darkmode?: boolean`
Enables **dark mode** for diagrams.
#### `stdrpt?: '' | 1 | 2`
Controls the error output format using the `-stdrpt` option. See [PlantUML command-line documentation](https://plantuml.com/en/command-line) for details.
#### `verbose?: boolean`
Enables logging output.
#### `quiet?: boolean`
Suppresses error messages in the console.
#### `timeout?: number`
Sets the **processing timeout** in seconds. Defaults to **900 seconds (15 minutes)**.
If you need support for additional arguments, [submit an issue](https://github.com/PrinOrange/remark-plantuml) to request it.
## Compatibility
This package requires **Node.js 18** or later.
- **Bundled JRE Version:** 17.0.14+7
- **PlantUML Version:** 1.2025.0
## Related Projects
- [PlantUML](https://github.com/plantuml/plantuml)
## Contributing
Test fixtures are generated and verified using **Linux**. Rendering results may slightly differ across platforms. If adding new test cases, don’t modify existing ones that cause CI failures. For general contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTION.MD).
## License
[MIT](./LICENSE.MD) © [但为君故](https://github.com/PrinOrange)
[downloads-badge]: https://img.shields.io/npm/dm/remark-embed-plantuml.svg
[downloads]: https://www.npmjs.com/package/remark-embed-plantuml
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=remark-embed-plantuml
[size]: https://bundlejs.com/?q=remark-embed-plantuml