Markdown files¶

Added in version 5.0.

Note

Support for this format is under development. Some features might not yet be available and the behavior can change between releases. Feedback from testing is welcome.

The translatable content is extracted from the Markdown files and offered for the translation. For Markdown files with JSX syntax, use MDX files.

Markdown units automatically get the md-text and auto-safe-html flags. This keeps the unsafe HTML check active for plain text, standard HTML, and custom elements while avoiding HTML cleanup on non-HTML angle-bracket syntax such as MDX or JSX-like components. Use the explicit safe-html flag for strings that are known to contain HTML and should always be sanitized, including SVG or MathML snippets.

Note

Unlike most other formats, the changes in the translation files will not be imported to Weblate because it can not be done reliably. The source of truth for the translations is Weblate not the translated file.

See also

Markdown

Example file:

# Ahoj světe!

Orangutan has five bananas.

Try Weblate at [weblate.org](https://demo.weblate.org/)!

*Thank you for using Weblate.*

Supported features¶
File extensions	`.md`
Linguality ⓘ	Monolingual
Supports plural ⓘ	`No`
Supports descriptions ⓘ	`No`
Supports explanation ⓘ	`No`
Supports context ⓘ	`No`
Supports location ⓘ	`No`
Supports flags ⓘ	`No`
API identifier	`markdown`
Supports read-only strings ⓘ	`No`
Check flags added by this format ⓘ	`auto-safe-html`, `strict-same`, `md-text`

Weblate configuration¶

Typical Weblate Component configuration
File mask	`path/*.md`
Monolingual base language file	`path/en.md`
Template for new translations	`path/en.md`
File format	Markdown file
File format parameters	`markdown_merge_duplicates=True`

Handling duplicate strings¶

By default, Weblate treats each occurrence of a string as a separate translation unit to provide line-based context. This can be problematic in Markdown tables, where reordering rows changes the context and can lead to translation loss.

To consolidate identical strings into a single translation unit, enable Deduplicate identical strings in the File format parameters.

Note

Enabling this option disables line-based context for the merged units, ensuring that translations remain stable even if rows or sections are moved within the document.