mystjs/dist/types/types.d.ts

Markdown parser for MyST markdown in JavaScript

import type MarkdownIt from 'markdown-it';
import type { Directive, IOptions as IDocutilsOptions, Role } from 'markdown-it-docutils';
import type { Options as HastOptions, Handler } from 'mdast-util-to-hast';
import type { MathExtensionOptions } from './plugins';
import type { MdastOptions, Spec, TransformOptions } from './mdast';
import type { Options as StringifyOptions } from 'rehype-stringify';
export interface IDirective {
    myst: typeof Directive;
    mdast: Spec;
    hast: Handler;
}
export interface IRole {
    myst: typeof Role;
    mdast: Spec;
    hast: Handler;
}
export declare type AllOptions = {
    roles: Record<string, IRole>;
    directives: Record<string, IDirective>;
    allowDangerousHtml: boolean;
    markdownit: MarkdownIt.Options;
    docutils: IDocutilsOptions;
    extensions: {
        colonFences?: boolean;
        frontmatter?: boolean;
        math?: boolean | MathExtensionOptions;
        footnotes?: boolean;
        deflist?: boolean;
        tasklist?: boolean;
        tables?: boolean;
        blocks?: boolean;
    };
    transform: TransformOptions;
    mdast: MdastOptions;
    hast: HastOptions;
    formatHtml: boolean;
    stringifyHtml: StringifyOptions;
};
export declare type Options = Partial<AllOptions>;