markdown-it-math
Version:
Markdown-it plugin to include math in your document
54 lines • 1.92 kB
TypeScript
export default function plugin(md: import("markdown-it").default, options?: PluginOptions | undefined): void;
export type MathupOptions = import("mathup").Options;
export type MarkdownIt = import("markdown-it").default;
export type Token = import("markdown-it/lib/token.mjs").default;
export type CustomElementOption = import("./options.js").CustomElementOption;
export type Delimiter = import("./options.js").Delimiter;
export type Renderer = import("./options.js").Renderer;
export type PluginOptions = {
/**
* - Inline math delimiters.
*/
inlineDelimiters?: string | import("./options.js").Delimiter[] | undefined;
/**
* - Deprecated: Use inlineDelimiters
*/
inlineOpen?: string | undefined;
/**
* - Deprecated: Use inlineDelimiters
*/
inlineClose?: string | undefined;
/**
* - If you want to render to a custom element.
*/
inlineCustomElement?: import("./options.js").CustomElementOption | undefined;
/**
* - Custom renderer for inline math. Default mathup.
*/
inlineRenderer?: import("./options.js").Renderer | undefined;
/**
* - If you want allow inline math to start or end with whitespace.
*/
inlineAllowWhiteSpacePadding?: boolean | undefined;
/**
* - Block math delimters.
*/
blockDelimiters?: string | import("./options.js").Delimiter[] | undefined;
/**
* - Deprecated: Use blockDelimiters
*/
blockOpen?: string | undefined;
/**
* - Deprecated: Use blockDelimiters
*/
blockClose?: string | undefined;
/**
* - If you want to render to a custom element.
*/
blockCustomElement?: import("./options.js").CustomElementOption | undefined;
/**
* - Custom renderer for block math. Default mathup with display = "block".
*/
blockRenderer?: import("./options.js").Renderer | undefined;
};
//# sourceMappingURL=plugin.d.ts.map