@vmprint/mkd-academic
v1.0.2
Published
Markdown → VMPrint DocumentInput transmuter with academic defaults.
Readme
@vmprint/mkd-academic
Markdown to VMPrint DocumentInput transmuter with built-in academic defaults.
Input is standard Markdown. Output is a pure object in VMPrint's AST format (DocumentInput), ready for JSON serialization or direct layout/rendering.
Features
- Zero file access. No
fs, no Node-specific loading. - No engine dependency. Types remain structurally compatible with
@vmprint/engine. - Built-in academic config and theme defaults.
- Caller overrides for
themeandconfig. - Images via data URIs or a caller-supplied resolver callback.
Installation
npm install @vmprint/mkd-academicUsage
import { transmute } from '@vmprint/mkd-academic';
const doc = transmute('# Title\n\nBody text.');
const customized = transmute('# Title', {
config: `references:\n heading: Works Cited\n`,
theme: `styles:\n paragraph:\n textAlign: justify\n`
});API
type AcademicTransmuteOptions = {
theme?: string;
config?: string;
resolveImage?: (src: string) => { data: string; mimeType: 'image/png' | 'image/jpeg' } | null;
};
function transmute(markdown: string, options?: AcademicTransmuteOptions): DocumentInput;Licensed under the Apache License 2.0.
