Oengus allows for markdown in a few places. This document serves as a guide and a cheat sheet in case you ever need help. Markdown on oengus is split into two sections, simple and advanced. Simple markdown is used for schedule runs, this only allows a few things. Advanced markdown allows pretty much everything!
Schedule lines, reffered to as "runs" in the UI, only allow very basic markdown in the runner, game and category fields. This markdown is as follows:
**bold text**=> bold text_italicised text_=> italicised text[Named links](https://oengus.io)=> Named links[Named links](https://oengus.io "With optional hover text")=> Named links
Advanced markdown supports all the basic syntax detailed on https://www.markdownguide.org/basic-syntax/ but it also supports some extras!
Missing a markdown feature on Oengus? Feel free to make an issue on github about it!
Please read the basic syntax guide, it contains a lot of useful info!
Oengus can convert text emojis to their unicode variants. An example of this is :wave: converting to 👋 (kinda like discord and GFM!)
Oengus supports markdown tables, they are not very responsive so use them with caution
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
The syntax looks like this:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |Just like GFM, oengus supports alerts via the alerts markdown extension, they look like the github ones.
Note
Highlights information that users should take into account, even when skimming.
Tip
Optional information to help a user be more successful.
Important
Crucial information necessary for users to succeed.
Warning
Critical content demanding immediate user attention due to potential risks.
Caution
Negative potential consequences of an action.
The syntax for that is as follows:
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.Not supported by github (so I can't easily preview it here without using images), but you can also put custom text in the header on oengus!
> [!TIP] Did you know?
> You can even put custom text in the header!