Text Formatting
Orb provides a custom Markdown implementation called OrbMarkdown to support rich text formatting in various parts of the application. This allows users to add structure and style to their content without needing complex HTML knowledge.
Where is it used?
OrbMarkdown is available in:
- Chats: Messages can be formatted.
- Game Details: Description, Player Requirements, etc.
Game Card Behavior
Formatting is disabled for Game Cards. It means text will be rendered as plain text without any Markdown formatting. This ensures a consistent appearance for all game cards, regardless of the content provided by Game Masters.
Note: as Card Snipped it shown only on Game Card it does not support formatting.
Supported Markdown Syntax
OrbMarkdown supports a specific subset of Markdown features. Below is the list of supported formatting options.
Text Styles
| Style | Syntax | Example | Result |
|---|---|---|---|
| Bold | **text** | **Bold Text** | Bold Text |
| Italic | *text* | *Italic Text* | Italic Text |
Code | `text` | `const x = 1` | const x = 1 |
Headings
Use # at the start of a line to create headings. OrbMarkdown supports up to 3 levels.
| Level | Syntax | Example |
|---|---|---|
| Heading 1 | # Text | # Main Title |
| Heading 2 | ## Text | ## Section Title |
| Heading 3 | ### Text | ### Subsection |
Lists
Create bulleted lists using * or - at the start of a line.
* Item 1
* Item 2
- Item 3
Links
You can create named links or let raw URLs be automatically converted.
| Type | Syntax | Example |
|---|---|---|
| Named Link | [text](url) | [Orb RPG](https://orbrpg.com) |
| Auto URL | https://... | https://google.com |
Paragraphs & Line Breaks
OrbMarkdown preserves line breaks similar to Discord message formatting.
- Line Breaks: A single new line in the editor creates a line break in the output. No need for double spaces.
- Paragraphs: Leave an empty line between text blocks to create a new paragraph.