Skip to content

Config: PalamedesMdxConfig

Functions, types, and exports for Config: PalamedesMdxConfig.

Page outline
import type { PalamedesMdxConfig } from "@palamedes/config"

type PalamedesMdxConfig = {
    framework?: "react" | "solid";
    translatableAttributes?: string[];
    frontMatterFields?: string[];
    transModule?: string;
    runtimeModule?: string;
    ignoreDirective?: string;
    /**
     * Include authored source messages in generated MDX modules as diagnostic
     * source metadata. Defaults to `false`; it never supplies runtime output.
     */
    includeSourceMetadata?: boolean;
};

Properties

NameTypeRequiredDescription
framework"react" | "solid"No
translatableAttributesstring[]No
frontMatterFieldsstring[]No
transModulestringNo
runtimeModulestringNo
ignoreDirectivestringNo
includeSourceMetadatabooleanNoInclude authored source messages in generated MDX modules as diagnostic
source metadata. Defaults to false; it never supplies runtime output.

Source entry on GitHub

Last updated: November 1, 2026