Unity Markdown Viewer

Fork

jeffcampbellmakesgames/UnityMarkdownViewer 3

Display markdown files directly in the Unity inspector with zero setup required. Supports customizable content width, optional toolbar toggling, and hyperlink events with cursor feedback. Ideal for in-editor documentation, changelogs, and embedded help systems.

com.jeffcampbellmakesgames.markdownviewer

editor-extension documentation markdown inspector-tools ui-editor

Unity Compatibility

Unity 6 Not tested

2023.2 Not tested

2023.1 Not tested

2022.3 LTS Not tested

2021.3 LTS Not tested

2020.3 LTS Not tested

2019.4 LTS Not tested

Install via UPM

Add to Unity Package Manager using this URL

https://www.pkglnk.dev/jeffcampbellmakesgames-markdownviewer.git

README Markdown

Copy this to your project's README.md

Style

Preview

## Installation

Add **Unity Markdown Viewer** to your Unity project via Package Manager:

1. Open **Window > Package Manager**
2. Click **+** > **Add package from git URL**
3. Enter:
```
https://www.pkglnk.dev/jeffcampbellmakesgames-markdownviewer.git
```

[![pkglnk](https://www.pkglnk.dev/badge/jeffcampbellmakesgames-markdownviewer.svg?style=pkglnk)](https://www.pkglnk.dev/pkg/jeffcampbellmakesgames-markdownviewer)

README

This fork adds a few tweaks needed for AssetUtility, which embeds two MarkdownViews in a documentation window.

Changes:

MarkdownViewer.Draw(float contentWidth = float.NaN)
Passing default value results in normal behavior, which would use the width of the entire editor window, but passing a value draws view in the specified width instead.
MarkdownViewer.drawToolbar { get; set; } = true;
Prevents the toolbar from being drawn if false, true is normal behavior.
HyperlinkHelper.HyperlinkOpened event Event is called when user presses a hyperlink. Event args provides cancel variable that can be used to disable normal behavior.
Changed cursor to MouseCursor.Link when hovering over a hyperlink.

Unity Markdown Viewer (UMV)

A markdown viewer for unity

UMV is a Unity editor extension for displaying markdown files in the inspector window.

It should just work without any setup or configuration.

Installation

Clone the repository into the project Packages directory

cd Packages
git clone https://github.com/gwaredd/UnityMarkdownViewer.git

Alternatively import the .unitypackage file from the releases page.

NB

Please note, I have renamed the master branch to main. This may affect existing clones.

Screenshots

Light Skin

Screenshot

Dark Skin