Skip to content

Demo vault

Every screenshot and code block on this page comes from the bundled demo vault.

Download the English demo vault

Documentation map ​

The docs are organised in seven groups and 27 pages: get it running, understand the model, then look up details. Every page answers one concrete question; if you are unsure where to start, use the problem index below.

Learning order ​

Getting started ​

PageAnswers
InstallHow to install and where to find it
Quick startHow to write the first gallery row
Core conceptsGalleries, rows, width, float, crop

Galleries ​

PageAnswers
GroupingWhich images become one row
Row splittingHow many per row, and how to pin 5+2
Row height and orphansWhy a row is capped, why one image leaves
Gallery handlesColumn drag, row drag, swap, merge, lock

Single images ​

PageAnswers
Width routingDefault width, and when an image centres
Float and wrapWhy text wraps, and where a float ends
Resize, align, resetCorner drag, left/right alignment, reset

Annotations and crops ​

PageAnswers
Annotation syntaxag: in alt text or on its own line
CroppingHow ag:crop and ag:top combine
Nested scopesLists, tables and callouts ownership
Dialog and resetWhat the dialog writes, what reset clears

Templates and routing ​

PageAnswers
Layout templatesReusing a whole width rhythm
Import and exportBacking up, sharing and merging profiles
Frontmatter routingSwitching rhythm per note

PDF export ​

PageAnswers
Export dialogPaper, margins and page numbers
PaginationThe five pagination rules
TroubleshootingBlank pages, missing images, fonts

Reference ​

PageAnswers
SettingsEvery switch, default and effect
CommandsCommands and where to trigger them
CompatibilityObsidian versions, themes, mobile
PitfallsWhy "it did not take effect"
ChangelogWhat changed in each version

Find by symptom ​

SymptomStart with
Images did not form a rowGrouping
A row split unexpectedlyRow splitting, Row height
An image is not as wide as expectedWidth routing
Text does not wrap beside an imageFloat and wrap
Crop looks wrongCropping
Images inside a list or table misbehaveNested scopes
A template change did nothingLayout templates, Routing
PDF has blank pages or split imagesPagination, Troubleshooting

Conventions ​

  • "Gallery" means the rows rendered from one contiguous image run, not the Obsidian gallery plugin.
  • ag: parameters are case-sensitive; ratios use 16:9, never 16/9.
  • Every example comes from the bundled demo/ and demo-en/ vaults, ready to open side by side.