Markdown is a handy way to write for the web, as it’s easy to read and write. Transifex supports standard Markdown syntax (as defined by John Gruber) and GitHub Flavored Markdown (GFM). Additionally, YAML front matter is supported.

As with HTML files, Transifex hides unnecessary syntax in the Editor while preserving them in the translated file.

If you use a static site generator such as Jekyll, you might have YAML front matter blocks with metadata or other variables in your Markdown files. Transifex supports both pre-defined variables (e.g., title) and custom variables. You’ll be able to translate values from these variables just like content from the body of your Markdown file.
​

For example, if you had this front matter block:

You’ll be able to translate these strings:

Transifex treats each line in a list as a single string and hides list markers in the Editor.

This list:

Will produce the following four strings in Transifex:

Each item in a GFM task list will also be treated as a single string, with the checkbox elements ([ ] and [x]) appearing in the Editor.

This task list:

Will produce the following four strings in Transifex:

There are multiple ways to produce code blocks with Markdown. Whether you use spaces, tabs, or ` to denote a code block, Transifex will treat each block as a single string.

By default, Transifex will check to ensure the number of spaces or tabs at the beginning of each line is preserved in the translation. If a translation has a different number of spaces than the source, the translator will see a Warning message, though you can customize this behavior in the translation check settings.

Tables are not part of the core Markdown spec defined by John Gruber, but Transifex supports them. Transifex will handle tables differently depending on whether it’s an HTML table or a GitHub Flavored Markdown table.

HTML tables like the one below will be treated as a single string.

However, Transifex treats each cell in a GFM table as a standalone string. This table:

Will produce the following six strings in Transifex:

In general, block-level elements in HTML are treated as a single string. This means large blocks of plain HTML will result in big source strings that are more difficult to translate and you won’t be able to take advantage of Translation Memory for those strings.

However, the HTML elements will be hidden from translators' view and only the translatable content will be exposed to the editor. Please check here for more details.

The following table outlines what occurs to untranslated, unreviewed and un-proofread strings when using the API, CLI or UI to manipulate translation files:

These are the default place holders that you could have in your file and they will be recognized :