Markdown

Markdown comes in many flavors. The one that is supported by Smartling is the GitHub flavor of markdown. If you’re unsure which flavor of Markdown you are using, someone on your technical team should know.

Before uploading your Markdown file to Smartling, be aware of the following:

Markdown translation is accomplished by transforming content into HTML so that it can be manipulated in translation tools and viewed in context with ease. Once translation is complete, the content is converted from HTML back into Markdown while the translated content is downloaded. As a result, your original Markdown document may differ in some ways from what is downloaded in the translated documents.

During the translation process, Smartling will try to maintain the same visual layout of your file but can’t guarantee that there won’t be some noticeable differences. Some post processing may be required to return the same formatting as the original document. See below for more details about the markdown formatting.

Directives

Format

Parsing of strings in markdown files can also be further customized with Smartling directives.  For this file format directives can only be specified for the entire file via the API.

placeholder_format_custom

See custom placeholder format article for more information.

smartling-cli files push "markdown.md" --type markdown --directive placeholder_format_custom="\{\{.+?\}\}"

primary_placeholder_format_custom

markdown_html_strategy

markdown_code_notranslate

Markdown Formatting

Below are some examples of known differences for markdown formatting in the translated file returned by Smartling.

Alternate Codes

Most Markdown styling can be represented by different Markdown code sequences (or character sequences). One code sequence will be consistently returned for any given style. For example:

H1 and H2 headers:

# Header 1
## Header2

Header 1
=======
Header 2
-------------

Italic and bold:

Text with _Italic_, __bold__, *Italic* , **bold**

Text with *Italic*, **bold**, *Italic* , **bold**

Formatting of code blocks is returned with an indentation style:

```
public void main()
{
// body
}
```

public void main()
{
// body
}

Escaping

The following characters are escaped with a backslash '\' in the downloaded file if they’re in the translated text:

\ backslash
* asterisk
_ underscore
{} curly braces
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
! exclamation mark

. dot sign is escaped when it is placed after a number (123\.)
The greater sign (>) is escaped when it is placed on the new line, or after the beginning of a
paragraph (if it is not a blockquote).

Script Tags

Literal (HTML markup inside markdown) script tags are removed.

<script type="text/javascript">
// JavaScript example

document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script>
okay

 okay

<script>
foo
</script>1. *bar*

1\. \*bar\*

Style Tags

Literal (HTML markup inside markdown) style tags are removed.

<style
 type="text/css">
h1 {color:red;}

p {color:blue;}
</style>
okay

 okay

Blockquotes

Blockquotes can be merged.

> foo

> bar

> foo
>
> bar

Bullets With Headings

Extra line breaks can sometimes be returned. 

- # Foo
- Bar
 ---
 baz

*

  Foo
  ===

*

  Bar
  ---

  baz

Lists

An extra line break is added between lists. 

- [x] foo
 - [ ] bar
 - [x] baz
- [ ] bim

* [x] foo
  * [ ] bar
  * [x] baz

* [ ] bim

Custom start position in numeric list currently is not supported.

123. Item 1
124. Item 2
125. Item 3

1. Item 1
2. Item 2
3. Item 3

Italics

Extra spacing can be added around certain styles.

 5*6*78

 5 *6* 78