import { PluginWithOptions } from 'markdown-it';

interface MarkdownItTexOptions<MarkdownItEnv = unknown> {
    /**
     * Math delimiter syntax to enable
     *
     * - `"brackets"`: Use `\(...\)` for inline math and `\[...\]` for display math (LaTeX style)
     * - `"dollars"`: Use `$...$` for inline math and `$$...$$` for display math (common Markdown style)
     * - `"all"`: Enable both bracket and dollar syntaxes
     *
     * 启用的数学分隔符语法
     *
     * - `"brackets"`: 使用 `\(...\)` 表示内联数学，使用 `\[...\]` 表示显示模式数学（LaTeX 风格）
     * - `"dollars"`: 使用 `$...$` 表示内联数学，使用 `$$...$$` 表示显示模式数学（常见 Markdown 风格）
     * - `"all"`: 启用括号和美元符号两种语法
     *
     * @default "dollars"
     */
    delimiters?: "brackets" | "dollars" | "all";
    /**
     * Whether parsed fence block with math language to display mode math
     *
     * 是否将解析的数学语言 fence 块转换为显示模式数学
     *
     * @default false
     */
    mathFence?: boolean;
    /**
     * Tex Render function
     *
     * @param content Text content
     * @param displayMode whether is display mode
     * @param env MarkdownIt environment
     * @returns render result
     *
     * Tex 渲染函数
     *
     * @param content 文本内容
     * @param displayMode 是否是显示模式
     * @param env MarkdownIt 环境变量
     * @returns 渲染结果
     */
    render: (content: string, displayMode: boolean, env: MarkdownItEnv) => string;
    /**
     * Whether to allow inline math with spaces on ends
     *
     * @description NOT recommended to set this to true, because it will likely break the default usage of $
     *
     * 是否允许两端带空格的内联数学
     *
     * @description 不建议将此设置为 true，因为它很可能会破坏 $ 的默认使用
     *
     * @default false
     */
    allowInlineWithSpace?: boolean;
}

/**
 * Forked from https://github.com/waylonflinn/markdown-it-katex/blob/master/index.js
 */

declare const tex: PluginWithOptions<MarkdownItTexOptions>;

export { tex };
export type { MarkdownItTexOptions };