Markdown Filter

From Okapi Framework
Jump to: navigation, search


The Markdown Filter is an Okapi component for extracting translatable text from Markdown files. See for more information about the format. Markdown is a family of formats, not all of them mutually compatible. This filter is designed to work with markdown based on the CommonMark specification, with additional features to support GitHub-flavored Markdown.

Processing Details

Input Encoding

The filter decides which encoding to use for the input file using the following logic:

If the file has a Unicode Byte-Order-Mark: Then, the corresponding encoding (e.g. UTF-8, UTF-16, etc.) is used. Otherwise, the input encoding used is the default encoding that was specified when setting the filter options.

Inline Codes

The filter attempts to convert inline formatting to codes and block-level formatting to document park/skeleton content.

The Inline Code Finder can be used to handle convert additional types of formatting to inline codes, as necessary.


Translate URLs
By default, URLs in link and image statements are not exposed for translation. If this option is enabled, they will be extracted. Note: URLs are currently extracted inline in their containing segment, rather than as a subflow.
Translate Code Blocks
This option, enabled by default, controls whether the contents of fenced code blocks are exposed for translation.
Translate YAML Metadata Header
Some markdown formats support a YAML Metadata Header that contains key/value data. By default, this header is not exposed for translation. When the "Translate YAML Metadata Header" option is enabled, the header will be parsed and the metadata values will be exposed for translation.


  • None known