VMPrint API Reference - v1.0.0
    Preparing search index...

    Module @vmprint/transmuter-mkd-literature

    @vmprint/transmuter-mkd-literature

    Markdown to VMPrint DocumentInput transmuter with built-in literature defaults.

    Input is standard Markdown. Output is a pure object in VMPrint's AST format (DocumentInput), ready for JSON serialization or direct layout/rendering.

    • Zero file access. No fs, no Node-specific loading.
    • No engine dependency. Types remain structurally compatible with @vmprint/engine.
    • Built-in literature config and theme defaults.
    • Caller overrides for theme and config.
    • Images via data URIs or a caller-supplied resolver callback.
    npm install @vmprint/transmuter-mkd-literature
    
    import { transmute } from '@vmprint/transmuter-mkd-literature';

    const doc = transmute('# Chapter One\n\nBody text.');

    const customized = transmute('# Chapter One', {
    config: `references:\n heading: Endnotes\n`,
    theme: `styles:\n paragraph:\n lineHeight: 1.6\n`
    });
    type LiteratureTransmuteOptions = {
    theme?: string;
    config?: string;
    resolveImage?: (src: string) => { data: string; mimeType: 'image/png' | 'image/jpeg' } | null;
    };

    function transmute(markdown: string, options?: LiteratureTransmuteOptions): DocumentInput;

    Licensed under the Apache License 2.0.

    Interfaces

    DocumentInput
    DocumentLayout
    Element
    ElementStyle
    Transmuter

    Type Aliases

    LiteratureTransmuteOptions
    LiteratureTransmuter
    ResolvedImage
    TransmuterOptions

    Variables

    DEFAULT_LITERATURE_CONFIG_YAML
    DEFAULT_LITERATURE_THEME_YAML
    transmuter

    Functions

    transmute