Markdown Asset

This adds markdown as an asset to the Unreal game engine.

Tested on UE 5.3

Note this also requires the Web Browser plugin to be enabled.

Behold, the latest game-changing feature in Unreal: Markdown! Why, you ask? Because sometimes, in the wild world of side projects, you need to document your midnight musings right where the magic happens – in the game editor itself! Now, you can scribble notes amid your digital dragons and spaceships. Genius or madness? Jury's still out. Really, I just fancied coding my own asset type for giggles. Any regrets? A smidge. But hey, it's done now. If others find it useful, brilliant! If not, at least my cat appreciates the extra keyboard time.

How to install

Clone this repo into your project's Plugins folder.
Build your project
Enable the Web Browser plugin (Edit -> Plugins from the menu)
Enable the Markdown Asset plugin (Edit -> Plugins from the menu)

How to use

Create an asset

In the content browser
Right click -> Miscellaneous -> Markdown Asset

Edit an asset

Double click the asset to edit
This will open the asset in the editor
You can switch between the editor and preview mode using the button in the top right

Settings

You can swap between a light and dark skin in the editor preferences
Edit -> Editor Preferences -> Plugins -> Markdown Asset

Unreal Engine Links integration

The plugin uses the UAssetEditorSubsystem from the engine to open any asset from a link to it.

You can add links to your project assets, C++ file or even specific functions of a C++ class.

How to link anything

You can directly copy and paste a reference to any asset or C++ file from the editor

Because Markdown files are assets too, you can reference them too! very useful to build one big index for your systems documentations

You can specify a function in a class link by adding ".FunctionName" at the end, right before the last "'" character. When clicked, the default IDE will show the class at the specific function.

i.e: to link the GetOwnerActor function inside the GameplayTask class the link is:

/Script/CoreUObject.Class'/Script/GameplayTasks.GameplayTask.GetOwnerActor'

Anatomy of a link to an asset

There are two important parts to link something from the engine: should starts with "/Script" and the actual link should be between two ' characters after that.

Examples of Valid links:

/Script/CoreUObject.Class'/Script/GameplayTasks.GameplayTask.GetOwnerActor'

/Script '/Game/ThirdPerson/Maps/ThirdPersonMap.ThirdPersonMap'

Markdown Extensions

The editor runs inside the unreal web browser client. Under the hood it is using markdown-it and I've enabled a bunch of plugins that extend the markdown language with some extra goodies. Here's a quick rundown of what's available.

Syntax Highlighting

Should be automatic for code blocks. You can specify the language like this:

```c++
#include "TestGamePlayerController.h"
#include "EnhancedInputSubsystems.h"

void ATestGamePlayerController::BeginPlay()
{
    Super::BeginPlay();
}
```

Tasks Lists

Are added like this:

- [x] fix closing browser warning
- [x] add custom icon
- [ ] better editing experience
- [ ] add dark and light themes

Which gives this:

Anchors

Headings are automatically given anchors, so you can link to them like this:

[Link](#ignore-extra-cells)

will jump to ...

## Ignore extra cells

You can automatically add a table of contents to your document like this:

[[toc]]

MathJax

You can add math equations with MathJax by wrapping them with $ or $$:

Inline

    $e^{i\pi} - 1 = 0$

Block

    $$
    \left( \frac{\partial^2}{\partial x^2} + \frac{\partial^2}{\partial y^2} \right) {| \varphi(x+ i y)|}^2 = 0
    $$

Gives ...

Diagrams

Diagrams can be added with GraphViz (see markdown-it-textual-uml for details).

For example:

```plantuml
Bob -> Alice : hello
```

```dot
digraph example1 {
    1 -> 2 -> { 4, 5 };
    1 -> 3 -> { 6, 7 };
}
```