@mdit/plugin-attrs
Version:
attrs plugin for MarkdownIt
52 lines (51 loc) • 1.13 kB
TypeScript
import { PluginWithOptions } from "markdown-it";
//#region src/helper/types.d.ts
interface DelimiterConfig {
/**
* left delimiter
*
* 左分隔符
*
* @default '{'
*/
left: string;
/**
* right delimiter
*
* 右分隔符
*
* @default '}'
*/
right: string;
/**
* allowed attributes
*
* @description An empty list means allowing all attribute
*
* 允许的属性
*
* @description 设置空数组意味着允许所有属性
*
* @default []
*/
allowed: (string | RegExp)[];
}
//#endregion
//#region src/options.d.ts
type MarkdownItAttrRuleName = "fence" | "inline" | "table" | "list" | "heading" | "hr" | "softbreak" | "block";
interface MarkdownItAttrsOptions extends Partial<DelimiterConfig> {
/**
* Rules to enable
*
* 启用的规则
*
* @default "all"
*/
rule?: "all" | boolean | MarkdownItAttrRuleName[];
}
//#endregion
//#region src/plugin.d.ts
declare const attrs: PluginWithOptions<MarkdownItAttrsOptions>;
//#endregion
export { MarkdownItAttrRuleName, MarkdownItAttrsOptions, attrs };
//# sourceMappingURL=index.d.ts.map