site/node_modules/mdast-util-math/lib/index.d.ts
2024-10-14 08:09:33 +02:00

39 lines
1.5 KiB
TypeScript

/**
* Create an extension for `mdast-util-from-markdown`.
*
* @returns {FromMarkdownExtension}
* Extension for `mdast-util-from-markdown`.
*/
export function mathFromMarkdown(): FromMarkdownExtension;
/**
* Create an extension for `mdast-util-to-markdown`.
*
* @param {ToOptions | null | undefined} [options]
* Configuration (optional).
* @returns {ToMarkdownExtension}
* Extension for `mdast-util-to-markdown`.
*/
export function mathToMarkdown(options?: ToOptions | null | undefined): ToMarkdownExtension;
export type HastElement = import('hast').Element;
export type HastElementContent = import('hast').ElementContent;
export type CompileContext = import('mdast-util-from-markdown').CompileContext;
export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension;
export type FromMarkdownHandle = import('mdast-util-from-markdown').Handle;
export type ToMarkdownHandle = import('mdast-util-to-markdown').Handle;
export type ToMarkdownExtension = import('mdast-util-to-markdown').Options;
export type InlineMath = import('../index.js').InlineMath;
export type Math = import('../index.js').Math;
/**
* Configuration.
*/
export type ToOptions = {
/**
* Whether to support math (text) with a single dollar (default: `true`).
*
* Single dollars work in Pandoc and many other places, but often interfere
* with “normal” dollars in text.
* If you turn this off, you can still use two or more dollars for text math.
*/
singleDollarTextMath?: boolean | null | undefined;
};