@argdown/core
    Preparing search index...

    Interface IHtmlExportSettings

    Settings used by the HTMLExportPlugin

    interface IHtmlExportSettings {
        allowFileProtocol?: boolean;
        charset?: string;
        createHeaderFromMetadata?: boolean;
        css?: string;
        cssFile?: string;
        head?: string;
        headless?: boolean;
        lang?: string;
        normalizeLink?: (url: string) => string;
        outputDir?: string;
        validateLink?: (url: string, allowFile: boolean) => boolean;
    }
    Index

    Properties

    allowFileProtocol? charset? createHeaderFromMetadata? css? cssFile? head? headless? lang? normalizeLink? outputDir? validateLink?

    Properties

    allowFileProtocol?: boolean
    charset?: string
    createHeaderFromMetadata?: boolean

    Create a document header from config data

    Looks for config.title, config.author, config.date, config.subTitle and config.abstract. If present will insert the data into a header section, using h1 for the title. The only field required for this is the title field.

    css?: string
    cssFile?: string

    External CSS file to include in the HTML head section.

    head?: string

    Optional setting to specify a custom head section.

    headless?: boolean

    Remove sourrounding html and body tags, remove head section of HTML.

    Instead a simple div containing the argdown HTML is returned.

    lang?: string
    normalizeLink?: (url: string) => string

    Function to normalize links.

    outputDir?: string

    Where should the html file be saved (if SaveAsPlugin is used)?

    validateLink?: (url: string, allowFile: boolean) => boolean

    Function to test if a link is valid.

    Settings

    Member Visibility

    On This Page

    Properties