Skip to content

Markdown Cheat Sheet

A quick reference for the Markdown syntax supported in PlayMaker.

You can use this syntax in PlayMaker Notes, Comment Nodes, Action List comments, Node descriptions, and Documentation assets.

The syntax includes standard Markdown features as well as custom extensions for Unity and PlayMaker.

Why Use Markdown in PlayMaker?

Markdown lets you add structure, emphasis, and formatting to your notes.
Use it to make FSM documentation clearer with headings, lists, links, and inline code.

Limitations

  • Inline images can only be placed at the beginning or end of text sections.

Headings

# H1
## H2
### H3

Emphasis

*Italic*
**Bold**
***Bold Italic***
~~Strikethrough~~

Lists

Unordered

- Item
  - Nested Item
    - Deeper
* Asterisk also works

Ordered

1. First
2. Second
   1. Sub-item

Check Lists

- [x] Done
- [ ] Not done

Rendered as check boxes that can be clicked:

  • Done
  • Not done

Clicking the check box edits the underlying markdown text.

All links use this format:

[Label](link)

Use # to link to headings (lowercase with hyphens replacing spaces):

[Check Lists](#check-lists)

Use https:// to link to web pages:

[example.com](https://example.com)

Use fsm: to link to FSM components:

[FSM Component](fsm:scene/path/to/gameobject)

Optionally select a state in the FSM:

[FSM Component](fsm:scene/path/to/gameobject:state-name)

Use var: to link to Variables in an FSM: 

[FSM Variable](var:variable-name)

Use event: to link to Events in an FSM:

[FSM Event](event:event-name)

Use state: to link to States in an FSM:

[State](state:state-name)

Use menu: to open a menu item:

[PlayMaker Addons](menu:PlayMaker/Addons)

Highlight Command

Use highlight: to call Highlighter.Highlight:

[Check the Rigidbody 2D settings](highlight:Inspector,Rigidbody 2D)

Images

![Alt Text](./relative/path/to/image.jpg)
![Alt Text](Assets/path/to/image.jpg)

Use width and/or height attributes to set the size of the image in pixels:

{width=32}![Alt Text](./image.jpg)

If only width or height is specified, the other dimension is calculated based on the image’s aspect ratio.

Note: Only local images are supported for now. Online images will not be downloaded.

Horizontal Rule

---
or
***

Custom Styles

Add a custom stylesheet using front matter (formatted text at the top of the markdown file):

---
uss: ./path/to/file.uss
---

Assign classes to blocks:

{.my-custom-class}
Class is assigned to this block.

Paths

Relative Paths

Start with . to define a path relative to the file or owner object.

For example:

If the markdown is on a GameObject in:

Assets/Scenes/MyScene.unity

And an image is at:

Assets/Images/MyImage.png

Then this is the relative path:

![image](../Images/MyImage.png)

Project Paths

Project paths should start with Assets/ or Packages/.

Use search:assetName to find a file in Assets.

Use packages:assetName to find a file in Packages.

Markdown Help Window

PlayMaker → Help → Markdown Help

The Markdown Help window shows the Markdown Cheat Sheet.

It also provides these helpers:

Get Icon Markdown

Opens a browser to select from all available icons. Select an icon to copy its markdown code to the clipboard. Paste this code into your notes to insert that icon.

Note, you can also select a color to add a tint to the markdown code.

Get Image Markdown

Opens an image browser. Select an image to copy markdown to the clipboard. Paste this markdown into notes to insert that image.