Member Junction
    Preparing search index...

    Interface MarkdownConfig

    Configuration options for markdown parsing/rendering.

    This is the framework-agnostic config shared by every consumer of @memberjunction/markdown-core — the Angular ng-markdown component, the React Native renderer, and any other UI layer. Flags that only affect one rendering target (e.g. enableMermaid, prismTheme) are still defined here so a single config object can drive all of them; each renderer reads the subset it understands.

    interface MarkdownConfig {
        autoExpandLevels?: number[];
        collapsibleDefaultExpanded?: boolean;
        collapsibleHeadingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
        containerClass?: string;
        enableAlerts?: boolean;
        enableCodeCopy?: boolean;
        enableCollapsibleHeadings?: boolean;
        enableHeadingIds?: boolean;
        enableHighlight?: boolean;
        enableHtml?: boolean;
        enableJavaScript?: boolean;
        enableLineNumbers?: boolean;
        enableMermaid?: boolean;
        enableSmartypants?: boolean;
        enableSvgRenderer?: boolean;
        headingIdPrefix?: string;
        mermaidTheme?: "auto" | "default" | "dark" | "forest" | "neutral" | "base";
        prismTheme?: string;
        sanitize?: boolean;
    }
    Index

    Properties

    autoExpandLevels? collapsibleDefaultExpanded? collapsibleHeadingLevel? containerClass? enableAlerts? enableCodeCopy? enableCollapsibleHeadings? enableHeadingIds? enableHighlight? enableHtml? enableJavaScript? enableLineNumbers? enableMermaid? enableSmartypants? enableSvgRenderer? headingIdPrefix? mermaidTheme? prismTheme? sanitize?

    Properties

    autoExpandLevels?: number[]

    Specify which heading levels should start expanded. Array of heading levels (2-6) that should be expanded by default. Takes precedence over collapsibleDefaultExpanded for specified levels.

    Examples:

    • [2] = Only h2 expanded, h3-h6 collapsed
    • [2, 3] = h2 and h3 expanded, h4-h6 collapsed
    • [] = All collapsed (same as collapsibleDefaultExpanded: false)
    • undefined = Uses collapsibleDefaultExpanded for all levels
    undefined (uses collapsibleDefaultExpanded)
    collapsibleDefaultExpanded?: boolean

    Whether collapsible sections should be expanded by default

    true
    collapsibleHeadingLevel?: 1 | 2 | 3 | 4 | 5 | 6

    Heading level at which to start collapsing (1-6) Only applies when enableCollapsibleHeadings is true

    2
    containerClass?: string

    Custom CSS class to apply to the markdown container

    enableAlerts?: boolean

    Enable GitHub-style alerts ([!NOTE], [!WARNING], etc.)

    true
    enableCodeCopy?: boolean

    Enable copy-to-clipboard button on code blocks.

    true
    enableCollapsibleHeadings?: boolean

    Enable collapsible heading sections.

    false
    enableHeadingIds?: boolean

    Enable GitHub-style heading IDs for anchor links

    true
    enableHighlight?: boolean

    Enable syntax highlighting for code blocks. The core does not highlight on its own — the consumer supplies a highlight function (e.g. Prism on web, react-native-syntax-highlighter on mobile).

    true
    enableHtml?: boolean

    Enable raw HTML passthrough in markdown content. When enabled, HTML tags in the markdown are rendered as actual HTML instead of being sanitized/stripped.

    Note: Even with enableHtml=true, scripts and event handlers are stripped unless enableJavaScript is also true.

    false
    enableJavaScript?: boolean

    Enable JavaScript execution in HTML content. When enabled,