Three different methods are supported for integrating Markdown, each with distinct characteristics.
MarkdownAsset #
A MarkdownAsset is the simple integration of a native .md file into the MarkdownRenderer.
How is it used?
Simply drag the Markdown file into Unity and reference it directly in the MarkdownRenderer. Alternatively, you can call the Render() function
from an external script and pass the .md file directly as a parameter since Unity interprets .md files directly as TextAssets.
Features:
- Headers
- Bold (text), Italics (text)
- Lists ( – item)
- Blockquotes (> text)
- Internal Images (base64)
- Tables
- Links
Advantages:
- Direct integration of .md files without conversion
- Native parsing of text content without conversions (faster)
Disadvantages:
- Does not support external files like external images, videos
- No multilingual support
Use Case:
- Simple text with internal images in base64 format
MarkdownZip #
A MarkdownZip contains a folder where external resources such as videos, images, and the actual .md files are stored in a compressed
format.
Features:
- Headers
- Bold (text), Italics (text)
- Lists (- item)
- Blockquotes (> text)
- Internal and external files
- Tables
- Links
Advantages:
- External files are not interpreted as base64 strings but stored temporarily.
- Supports multilingual features.
- Resources are compressed in a single file instead of being referenced as individual Unity assets
Disadvantages:
- Slower but works asynchronously.
- Extra step for compression.
How is it used?
Write the Markdown file and use external resources. These must be in a subdirectory along with the .md file. This folder is then converted
in Unity using our conversion tool. The resulting .bytes file can then be used as a TextAsset with the MarkdownRenderer.
Use Case:
- Text with both internal and external files and multilingual support.
Markbook #
Markbook enables you to bundle multiple MarkdownZip files, allowing you to treat them as individual chapters. The advantage is that
different documents can be easily combined.
Use Case:
- Multiple chapters with internal and external files and multilingual support.
