@mdit/plugin-attrs/dist/index.d.ts

attrs plugin for MarkdownIt

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
   *
   * An empty list means allowing all attribute 允许的属性
   *
   * 设置空数组意味着允许所有属性
   *
   * @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 { type MarkdownItAttrRuleName, type MarkdownItAttrsOptions, attrs };
//# sourceMappingURL=index.d.ts.map