hackmd-to-html-cli/dist/converter.d.ts

A node.js CLI tool for converting HackMD markdown to HTML.

import { Metadata } from './markdown/yamlMetadata';
import MarkdownIt from 'markdown-it';
export interface ConvertedResult {
    main: string;
    metadata: Metadata;
}
export declare class Converter {
    private md;
    private metadata?;
    constructor(options?: MarkdownIt.Options);
    /**
     * @param markdown markdown text
     *
     * @returns ConvertedResult contains `main` and `metadata`
     *
     * ```
     * ConvertedResult {
     *       main: string;        // generated html text
     *       metadata: Metadata;  // parsed metadata
     * }
     *
     * Metadata {
     *       title: string;
     *       description: string;
     *       lang: string;
     *       robots: string;
     *       dir: string;
     *       image: string;
     * }
     * ```
     */
    render(markdown: string): ConvertedResult;
}
//# sourceMappingURL=converter.d.ts.map