Markdown → TMP — Lightning-fast Markdown renderer for TextMesh Pro
Key Features
- One-click component: just add the “Md Label” script and paste your Markdown.
- Full support for GitHub Flavoured Markdown: headings, lists, links, code fences, tables and inline formatting.
- Built-in syntax highlighting for Python, JavaScript, TypeScript, Bash, and Rust.
- Automatic conversion of Markdown tables into perfectly aligned monospace ASCII tables.
- No external DLLs required – includes lightweight Markdig and optional ColorCode highlighters as C# source.
- Editor live preview via Unity’s OnValidate mechanism.
Dependencies and Requirements
- Unity 2021.3 LTS or newer (supports all render pipelines).
- TextMesh Pro version 3.0.6 or later (installable via Unity Package Manager).
- Uses Markdig 0.30+ for Markdown parsing and System.Text.RegularExpressions for highlighting: https://github.com/xoofx/markdig
- Optional: Define COLORCODE_INSTALLED in your scripting symbols to use ColorCode-based highlighting instead of the default engine.
- Thaleah Font: https://tinyworlds.itch.io/free-pixel-font-thaleah
- JetBrains Mono Font: https://www.jetbrains.com/lp/mono/
-
Package Contents
- 12 C# source files (clean, documented, no DLLs or native plugins)
- 2 SDF font asset: JetBrainsMono-Regular for code blocks and Thaleah Fat for Pixel Font
- 0 Editor scripts – runtime only, no pollution of the Unity Editor namespace
Limitations and Transparency
- Inline raw HTML, footnotes, and definition lists are currently not supported.
- Extremely large documents (over 10,000 lines) may cause temporary string allocations; consider splitting.
- The highlighter registry is not thread-safe – register or modify highlighters on the main thread only.
- TextMesh Pro’s rich-text tags rely on correct color space settings. For URP or HDRP projects, use Linear color space for accurate display.
Versions / Editions
This package is only offered in a single version. There is no “lite” or “pro” tier – all features are fully included.
To use a font in the Markdown follow these steps:
Create the SDF by rightclicking your Font and choose Create-->Text Mesh Pro --> Font Asset.
Then copy the SDF file into Assets/TextMeshPro/Resources/Fonts&Materials
Use the the exact filename in the Markdown: <font="JetBrainsMono-Regular SDF">
You can contact me at max.lnfritsche@gmail.com or at https://illuminated-subtasks-124140.framer.app/legalnotice.
Description sourced from the Unity Asset Store listing.
