@mdit/plugin-plantuml

Plugin to support plant uml base on @mdit/plugin-uml.

Usage

import { plantuml } from "@mdit/plugin-plantuml";
import MarkdownIt from "markdown-it";

const mdIt = new MarkdownIt().use(plantuml);

mdIt.render(`\
@startuml
Bob -> Alice : hello
@enduml
`);

Options

type"uml" | "fence"

Default"uml"

Plantuml parse type.

namestring

Default"uml"

Diagram type. Only available when using default srcGetter.

fencestring

Fence info. Defaults to the value of name.

openstring

Opening marker. Only available with type "uml". Defaults to "start" + name.

closestring

Closing marker. Only available with type "uml". Defaults to "end" + name.

serverstring

Default"https://www.plantuml.com/plantuml"

Plantuml server. Only available when using default srcGetter.

External requests

With the default srcGetter, the diagram source is sent to the configured PlantUML server (https://www.plantuml.com/plantuml by default), which is an external request that may leak diagram content. Self-host the server or provide a custom renderer when the diagram source is sensitive.

formatstring

Default"svg"

Image format. Only available when using default srcGetter.

srcGetter(content: string) => string

Image src getter. Takes diagram content and returns image link.

rendererRendererRule

/**
 * @param tokens - List of tokens.
 * @param index - Current token index.
 * @param options - Markdown-it options.
 * @param env - Markdown-it environment.
 * @param self - Markdown-it renderer instance.
 *
 * @returns Rendered HTML string.
 */
type RendererRule = (
  tokens: Token[],
  index: number,
  options: Required<MarkdownItOptions>,
  env: Env | undefined,
  self: Renderer,
) => string;

Diagram renderer.

Demo

demo

@startuml
Bob -> Alice : hello
@enduml

Non-ascii demo

@startuml
Bob -> Alice : 你好
@enduml

---

See the comparison report for the full upstream comparison.