This is the interface between the Markdown text and the Unity UI. It uses the integrated parser, which is called asynchronously.

Input #

Here you define which Markdown content will be rendered.
The Markdown Asset is a simple text asset and can be directly assigned from a .md file.
The Markzip Asset is created by a preprocessing step to include external content. More about this in the Markzip chapter.

You can also call the asset and render function directly via C#:

using MarkdownToUnity;
public MarkdownRenderer markdownRenderer;
markdownRenderer.Render(TextAsset obj);

Styles #

Setting	Description
Visual Element Scale Factor	Adjusts the size of visual elements (e.g., images and videos) after rendering. Depending on the desired overall size, elements can be scaled larger or smaller.
Default Text Color	Sets the default color of the text.
Default Text Size	Defines the default text size.
Default Font	Specifies the default font.
Table Grid Width	Sets the line width of table borders.
Table Grid Color	Sets the line color of table borders.
Cell Padding	Defines the inner padding of table cell contents.

Elements #

These elements are instantiated during rendering.
Adjust objects such as horizontal lines, text, or blockquotes to your needs — they serve as templates used to generate the final UI elements.

Replace the spinner to display the loading state differently. It is only visible for larger compressed Markzip files.

Multilanguage Support #

Set Use Language Marker to true if you want to use multiple .md versions in different languages.
Save the translations in the same folder as all other resources. Since the paths to external files are identical to those of the translated files, they will be used automatically.

Add a unique language marker to the filename so it can be detected. For example: EN, GER, ESP, etc.
If no matching file is found, the first .md file will be displayed, or a file with the default marker, which is set to "EN" by default.
You can change this default marker in the MarkdownToUnityParser class.

The current language is represented by the Language Marker of the MarkdownRenderer.