Markdown format (.md, .markdown)

The Markdown format reads Markdown documents, extracts prose as translatable blocks, and writes the translations back while preserving the document's structure: headings, lists, emphasis, links, and code. Inline markup (bold, italic, links, inline code) is exposed as inline codes inside each block so the surrounding syntax survives translation.

By default paragraphs, headings, list items, blockquotes, and image alt text are translatable, while code blocks, YAML front matter, raw HTML blocks, and link/image URLs are emitted as non-translatable structure. Each of those categories can be toggled, and embedded HTML can be routed to a subfilter.

IDmarkdown

SourceBuilt-in

Extensions.md, .markdown

MIME Typestext/markdown, text/x-markdown

CapabilitiesRead + Write

How kapi reads it

Parameters

Parameter	Type	Default	Description
`codeFinderRules`	array		Regex-mønstre som samsvarer med innebygde koder i oversettbar tekst
`extractNonTranslatableContent`	boolean	true	Hvis sann (standard), vises ikke-oversettbart kontekstuelt innhold som kodeblokker som innholdsblokker (synlig for innlesing/LLM-konsumenter, hoppes over av maskinoversettelse) i stedet for å være skjult i skjelett. Deaktiver for å beholde det i skjelett.
`frontMatterKeys`	array		Nøkler i frontmatter som skal trekkes ut når translateFrontMatter er på (tom = alle skalarverdier). Angi nøklene som inneholder prosa, f.eks. title og description.
`subfilter`	string		Underfilterformat som skal brukes på HTML-innhold i Markdown (f.eks. 'html')
`translateBlockQuotes`	boolean	true	Hvis sann, er blokksitatinnhold oversettbart.
`translateCodeBlocks`	boolean	false	Hvis sann, er gjerdet og innrykket kodeblokker oversettbare. Hvis usann, sendes de ut som ikke-oversettbare data.
`translateFrontMatter`	boolean	false	Hvis sann, er YAML front matter-verdier oversettbare. Hvis usann, sendes de ut som ikke-oversettbare data.
`translateHTMLBlocks`	boolean	false	Hvis true, er rå HTML-blokker oversettbare. Hvis false, emitteres de som ikke-oversettbare data.
`translateImageAlt`	boolean	true	Hvis sann, inkluderes alt-tekst for bilder i oversettbart innhold.
`translateURLs`	boolean	false	Hvis sann, er lenke- og bilde-URL-er oversettbare.
`unescapeBackslashCharacters`	boolean	false	Analyser omvendt skråstrek-escaped tegnsetting i kildedokumenter
`useCodeFinder`	boolean	false	Aktiver regex-basert deteksjon av innebygd kode i oversettbar tekst

Configure it live

Configuration

Loading form…

Examples

Translate front matter too

Include YAML front matter values alongside the prose.

translateFrontMatter: true

Handle embedded HTML structurally

Route inline and block HTML through the HTML subfilter.

subfilter: html

Processing notes

Inline markup (emphasis, links, inline code) becomes inline codes within blocks, so it survives translation unchanged.
Structural elements (fences, list markers, heading prefixes) form the non-translatable skeleton.

Limitations

Code blocks, front matter, raw HTML blocks, and URLs are non-translatable by default; enable the corresponding option to extract them.

← Back to the Format Reference