Formatting Guide
Everything you can do with GrimoirePrint — with examples.
Headings
Use # symbols for hierarchical headings. Each level gets distinct styling in the D&D
theme.
Text Formatting
Standard Markdown inline formatting is fully supported.
Bold text for important things
Italic text for flavour
inline
code for game mechanics
Tables
Pipe-delimited tables with alignment support. Use :---: for center, ---:
for
right.
| d4 | Creature | CR |
|---|---|---|
| 1 | Fire Snake | 1 |
| 2 | Mephit | 1/2 |
| 3 | Salamander | 5 |
Read Aloud
Dramatic narration text for reading to players. Renders as a parchment-styled italic box with a gold border.
DM Notes
Dark sidebar callouts for DM-only information. Perfect for keeping secrets organized.
Stat Blocks
Monster Manual-style stat blocks with gradient borders, horizontal rules, and inline ability score tables.
Small Humanoid, Neutral Evil
AC 17 (chain mail)
HP 21 (6d6)
Speed 30 ft.
<!-- img: images/goblin.png --> — the image will float to the right.
Loot & Treasure
Gold-bordered treasure boxes for listing rewards and loot drops.
- Crown of the Mountain King
- Flame Tongue Greatsword
- 15,000 gp in mixed coinage
- 3 rubies worth 1,000 gp
Skill Checks
Green-accented callout for ability checks and skill challenges.
DC 18 Stealth to approach without waking the dragon.
Traps & Hazards
Red-bordered callout for traps and environmental hazards. Visually distinct from regular narration.
DC 15 Perception to spot. DC 13 Dex save or 2d6 poison.
NPC Quick Reference
Purple-accented callout for NPC profiles — lighter weight than a full stat block.
Human innkeeper, 50s
Wants: Clear the cellar goblins.
Secret: Zhentarim fence.
Quest Hooks
Amber-highlighted callout for quest objectives — scannable at a glance during play.
200gp for information about three missing caravans.
Area Keys
Brown dashed-border callout for keyed location descriptions.
15×20 ft. Three bunks, a weapon rack, and a locked chest (DC 12).
Dialogue
Italic speech-styled callout for scripted NPC dialogue, distinct from read-aloud narration.
General Alerts
GitHub-style alerts for notes, tips, warnings, cautions, and important information. Useful for both D&D and general-purpose documents.
Aside / Sidebar
Inset panel for lore, history, or world-building context that enriches but isn't essential to the scene.
In 1247 DR, the Courts signed a fragile treaty...
Roll Tables
Themed wrapper for random encounter or roll tables with a distinct header.
Banners
Full-width dramatic chapter or act banners with large, centered typography.
Page Breaks
Force an explicit page break at any point in your document.
Column Toggle
Switch between 1-column and 2-column layout mid-document.
Section Backgrounds
Add atmospheric background images to any section using an HTML comment after a heading.
Content here appears over a faded background watermark…
Two-Column Layout
Use the 2 Col option (or --columns 2 in CLI) for a newspaper-style layout.
Section headings and tables automatically span both columns.
The ancient wyrm stirs in its mountain stronghold. Your party must brave the scorching tunnels.
Gold coins carpet the floor in drifts, and atop the glittering hoard, a single enormous eye opens.
Sections & Tabs
Each ## Heading starts a new section with a coloured tab on the right margin, automatic
page
break, and a drop cap on the first paragraph.
The weary adventurers push open the oak door…
Below the city, ancient tunnels…
Wide Callouts
In two-column mode, add WIDE after the callout type to span the full page width.
- Treasure that spans both cols
- Crown of the Mountain King
Footnotes
Add footnote references inline and definitions at the bottom. Works with all themes.
Highlighted Text
Mark important text with a warm highlight. Works with all themes.
The password is swordfish — don’t share it.
Definition Lists
Term-and-definition pairs for glossaries, rules references, and technical docs.
- Armor Class
- How hard a creature is to hit.
- Hit Points
- How much damage a creature can take.
Smart Typography
Automatic typographic improvements for professional output. Applied to all themes.
“Hello” – she said…
It’s a brand-new — era.
Quick Reference
All supported formatting commands at a glance.
| Feature | Syntax | Description |
|---|---|---|
| Read Aloud | > [!READ] |
Parchment italic box for narration |
| DM Notes | > [!DM] |
Dark sidebar for DM secrets |
| Stat Block | > [!STAT] |
Monster Manual-style stat block |
| Treasure | > [!LOOT] |
Gold-bordered loot box |
| Skill Check | > [!SKILL] |
Green-bordered check callout |
| Wide Mode | > [!TYPE WIDE] |
Span both columns (2-col mode) |
| Background | <!-- bg: path --> |
Section background image |
| Stat Image | <!-- img: path --> |
Floating image in stat block |
| Trap | > [!TRAP] |
Red danger border for traps/hazards |
| NPC | > [!NPC] |
Purple-accented NPC quick reference |
| Quest | > [!QUEST] |
Amber quest hook/objective |
| Area Key | > [!MAP] |
Dashed brown keyed location |
| Dialogue | > [!DIALOGUE] |
Italic speech / NPC dialogue |
| Note | > [!NOTE] |
Blue info note (GitHub-style) |
| Tip | > [!TIP] |
Green tip/best practice |
| Warning | > [!WARNING] |
Orange warning alert |
| Caution | > [!CAUTION] |
Red high-risk caution |
| Important | > [!IMPORTANT] |
Purple essential info |
| Aside | > [!ASIDE] |
Sidebar/lore inset panel |
| Roll Table | > [!TABLE] |
Themed roll table wrapper |
| Banner | > [!BANNER] |
Full-width dramatic chapter banner |
| Page Break | <!-- pagebreak --> |
Force an explicit page break |
| Column Toggle | <!-- cols: 1 --> |
Switch to single/two column layout |
| Headings | # to ###### |
Six levels, themed typography |
| Tables | | col | col | |
Pipe tables with alignment |
| Bold | **text** |
Strong emphasis |
| Italic | *text* |
Emphasis / flavour text |
| Code | `text` |
Inline monospace |
| H. Rule | --- |
Horizontal rule / divider |
| Lists | - item / 1. item |
Bullet and numbered lists |
| Footnotes | text[^1] / [^1]: note |
Numbered footnotes with back-references |
| Highlight | ==text== |
Highlighted / marked text |
| Def. List | Term\n: Definition |
Term & definition pairs |
| Smart Type | Automatic | Curly quotes, em/en dashes, ellipses |