Skip to content
CtrlK

MarkdownConfig

On this page
import type { MarkdownConfig } from "ardo/config"

type MarkdownConfig = {
    /** Ferriki syntax-highlighting theme name or light/dark theme pair. */
    theme?: {
        light: ThemeInput;
        dark: ThemeInput;
    } | ThemeInput;
    /** Show line numbers in code blocks */
    lineNumbers?: boolean;
    /** Enable anchor links for headings */
    anchor?: boolean;
    /** Table of contents configuration */
    toc?: {
        level?: [number, number];
    };
} & NativeMarkdownConfig;

Properties

NameTypeRequiredDescription
theme{ light: ThemeInput; dark: ThemeInput } | ThemeInputNoFerriki syntax-highlighting theme name or light/dark theme pair.
lineNumbersbooleanNoShow line numbers in code blocks
anchorbooleanNoEnable anchor links for headings
toc{ level?: [number, number] }NoTable of contents configuration
tableAttributesbooleanNo
headingAttributesbooleanNo
cjkEmphasisbooleanNo
imageAttributesbooleanNoParse {#id .class} directly after an image. Default: off.
imageCaptionsbooleanNoAttach a separate : Caption line to a standalone image. Default: off.
extendedAttributesbooleanNoEnable shared key/value attributes on headings, links, images, tables, and figures.
bracketedSpansbooleanNoEnable [inline Markdown]{attributes} spans.
blockquoteAttributionsbooleanNoAttach a separate : Author line after a block quote. Default: off.
insertionsbooleanNoEnable ++inserted text++. Default: off, including the GFM profile.
guillemetDigraphsbooleanNoPreserve <<…>> as inline text and allow typography to map balanced pairs. Default: off.
tablesbooleanNoEnable GFM pipe tables. Default: on.
mergedTableCellsbooleanNoEnable MultiMarkdown-style table column spans. Default: off; requires tables.
strikethroughbooleanNoEnable GFM ~~strikethrough~~. Default: on.
superscriptbooleanNoEnable ^superscript^. Default: off.
subscriptbooleanNoEnable ~subscript~. Default: off.
taskListsbooleanNoEnable GFM task lists. Default: on.
autolinkLiteralsbooleanNoEnable bare URL, www, and email autolinks. Default: off.
footnotesbooleanNoEnable [^label] footnotes. Default: off.
highlightbooleanNoEnable ==marked text==. Default: off. Independent of code highlighting.
inlineFootnotesbooleanNoEnable ^[inline notes]. Default: off; independent of footnotes.
allowLinkRefsbooleanNoResolve link/image references and consume definitions. Default: on.
headingOffsetnumberNoSigned 32-bit integer heading shift; positive values move toward h6, clamped to h1–h6. Default: 0.
headingIdPrefixstringNoPrefix heading IDs and generated permalink fragments. Safe characters: ASCII letters, digits, _, and -.
mathbooleanNoEnable $inline$ and $$display$$ math. Default: off.
calloutsbooleanNoEnable GitHub-style blockquote callouts. Default: on.
definitionListsbooleanNoEnable PHP Markdown Extra definition lists. Default: off.
lineCommentsbooleanNoOmit physical-line-start // source comments. Default: off.
typographyTypographyOptionsNoApply explicit locale-aware typography after parsing. Default: off.
passesNativePassOptions[]NoRun native transform passes in the given order. Cannot be combined with typography.