myst-cli/dist/process/myst.d.ts

Command line tools for MyST

import { type AllOptions } from 'myst-parser';
import type { ISession } from '../session/types.js';
import type { GenericParent } from 'myst-common';
/**
 * Boiled-down options for parseMyst
 *
 * These options are far simpler than the extensive options allowed
 * if myst-parser and markdown-it are used directly.
 */
type Options = {
    ignoreFrontmatter?: boolean;
};
export declare function getMystParserOptions(session: ISession, opts?: Options): Partial<AllOptions>;
/**
 * Parse MyST content using the full suite of built-in directives, roles, and plugins
 *
 * @param session session with logging
 * @param content Markdown content to parse
 * @param file path to file containing content
 */
export declare function parseMyst(session: ISession, content: string, file: string, opts?: Options): GenericParent;
export {};
//# sourceMappingURL=myst.d.ts.map