@mdit/plugin-plantuml
Version:
plantuml plugin for MarkdownIt
92 lines (91 loc) • 1.85 kB
TypeScript
import { RenderRule } from "markdown-it/lib/renderer.mjs";
import { PluginWithOptions } from "markdown-it";
//#region src/options.d.ts
interface MarkdownItPlantumlOptions {
/**
* Plantuml parse type
*
* Plantuml 解析类型
*
* @default "uml"
*/
type?: "uml" | "fence";
/**
* Diagram type
*
* Only available when using default srcGetter 图表类型
*
* 仅在使用默认地址获取器时可用
*
* @default "uml"
*/
name?: string;
/**
* Fence info
*
* 代码块名称
*
* @default name
*/
fence?: string;
/**
* Opening marker
*
* Only available with type "uml" 开始标记
*
* 仅当类型为 "uml" 时可用
*
* @default "start" + name
*/
open?: string;
/**
* Closing marker
*
* Only available with type "uml" 结束标记
*
* @default "end" + name
*/
close?: string;
/**
* Plantuml server
*
* Only available when using default srcGetter Plantuml 服务器
*
* 仅在使用默认地址获取器时可用
*
* @default "https://www.plantuml.com/plantuml"
*/
server?: string;
/**
* Image format
*
* Only available when using default srcGetter 图片格式
*
* 仅在使用默认地址获取器时可用
*
* @default "svg"
*/
format?: string;
/**
* Image src getter
*
* @param content Diagram content
* @param content 图表内容
* @returns Image link
* 图片地址获取器
* @returns 图片链接
*/
srcGetter?: (content: string) => string;
/**
* Diagram renderer
*
* 图表渲染器
*/
render?: RenderRule;
}
//#endregion
//#region src/plugin.d.ts
declare const plantuml: PluginWithOptions<MarkdownItPlantumlOptions>;
//#endregion
export { type MarkdownItPlantumlOptions, plantuml };
//# sourceMappingURL=browser.d.ts.map