@mdit/plugin-stylize/lib/index.d.ts

stylize plugin for MarkdownIt

import { PluginWithOptions } from 'markdown-it';

interface MarkdownItStylizeResult {
    /**
     * Tag name
     *
     * 渲染的标签名称
     */
    tag: string;
    /**
     * Attributes settings
     *
     * 属性设置
     */
    attrs: Record<string, string>;
    /**
     * Tag content
     *
     * 标签内容
     */
    content: string;
}
interface MarkdownItStylizeConfig {
    /**
     * Inline token matcher
     *
     * 字符匹配
     */
    matcher: string | RegExp;
    /**
     * Content Replacer
     *
     * 内容替换
     */
    replacer: (options: {
        tag: string;
        content: string;
        attrs: Record<string, string>;
        env?: any;
    }) => MarkdownItStylizeResult | null | undefined | void;
}
interface MarkdownItStylizeOptions {
    /**
     * Stylize config
     *
     * 格式化配置
     */
    config?: MarkdownItStylizeConfig[];
    /**
     * Local config getter
     *
     * @param env Markdown env object
     * @returns local stylize config
     *
     * 本地配置获取器
     *
     * @param env Markdown 环境对象
     * @returns 本地格式化配置
     */
    localConfigGetter?: (env?: any) => MarkdownItStylizeConfig[] | null;
}

declare const stylize: PluginWithOptions<MarkdownItStylizeOptions>;

export { stylize };
export type { MarkdownItStylizeConfig, MarkdownItStylizeOptions, MarkdownItStylizeResult };