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

    Module @vmprint/transmuter-mkd-screenplay

    @vmprint/transmuter-mkd-screenplay

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

    This transmuter mirrors screenplay semantics from draft2final, including title-page metadata routing, scene-heading recognition, dialogue/parenthetical handling, and dual-dialogue emission.

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

    const doc = transmute(markdown);
    type ScreenplayTransmuteOptions = {
    theme?: string;
    config?: string;
    resolveImage?: (src: string) => { data: string; mimeType: 'image/png' | 'image/jpeg' } | null;
    };

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

    Licensed under the Apache License 2.0.

    Interfaces

    DocumentInput
    DocumentLayout
    Element
    ElementStyle
    Transmuter

    Type Aliases

    ResolvedImage
    ScreenplayTransmuteOptions
    ScreenplayTransmuter
    TransmuterOptions

    Variables

    DEFAULT_SCREENPLAY_CONFIG_YAML
    DEFAULT_SCREENPLAY_THEME_YAML
    transmuter

    Functions

    transmute