Skip to main content
Version: In-Progress

Gallery Builder

Gallery View includes an interactive Gallery Builder modal that lets you compose obs-gallery blocks visually — no YAML writing required.

Opening the Builder

From the Obsidian command palette (Ctrl+P / Cmd+P), run:

Gallery View: Insert gallery

The builder opens as a modal. When you click Insert gallery at the bottom, the generated YAML is inserted at your cursor position in the editor.


Using the Builder

1. Choose a View Type

Select the gallery layout from the View type dropdown:

OptionDescription
GridMasonry-style layout with variable-height images.
ThumbnailFixed-size thumbnail grid. Clicking an image opens the full-size modal viewer.
CarouselHorizontally scrolling view with previous/next navigation.

2. Add Sources

Click the Add source dropdown and select a source type. You can add as many sources as you need — the gallery will load images from all of them:

Source TypeDescription
Local VaultImages from a folder or file in your vault.
External URLsRemotely hosted images (requires Allow remote images to be enabled in Settings).
Immich Share LinkImages from a public Immich share URL.
Immich AuthenticatedAlbums, favorites, or filtered assets from your personal Immich library.

Each source type shows its own configuration fields after being added.

Local Vault source options

FieldDescription
PathVault-relative folder or file path, e.g. Photos/Vacation.
RecursiveToggle to include images in subfolders (default: on).

External URLs source options

Enter one or more remote image URLs. Use Add URL to add additional entries and Remove to delete them.

FieldDescription
Share URLThe public Immich share link.
Password(Optional) password if the share is protected.

Immich Authenticated source options

[!NOTE] You must have at least one Immich connection configured in Settings → Gallery View → Providers before this source type becomes available. If no connections are configured, the builder will prompt you to add one first.

SectionDescription
ConnectionDropdown of your configured Immich connections. Changing the connection refreshes the Albums, Tags, and People lists.
Favorites onlyToggle to filter to only favorited assets.
Asset typeChoose All, Image, or Video.
Created after / beforeDate range filters in YYYY-MM-DD format.
AlbumsSearchable, multi-select list of your Immich albums.
TagsSearchable, multi-select list of your Immich tags (human-readable names).
PeopleSearchable, multi-select list of recognized people in your Immich library.
LimitMaximum number of assets to fetch.
Sort orderOldest first (asc), Newest first (desc), or default.

Use the Refresh metadata button to clear the builder's cache and re-fetch albums, tags, and people from Immich (useful if you have recently added new content).

3. Preview and Insert

The Live preview panel at the bottom of the modal shows the YAML that will be inserted. It updates in real time as you change settings.

Once you're happy with the configuration, click Insert gallery. The block is inserted at your cursor and the modal closes.


YAML Autocomplete

In addition to the builder modal, Gallery View provides IntelliSense-style completions directly inside obs-gallery code blocks while you type.

Completions are triggered automatically when your cursor is inside an obs-gallery block. The following fields have autocomplete support:

FieldSuggestions
type:local, immich, immich-share
connection:Your configured Immich connection keys (with their base URLs shown as descriptions)
view:grid, carousel, thumbnail
assetType:IMAGE, VIDEO
sort.order:asc, desc
Items in albumIds: listAlbum names fetched live from Immich (inserts the UUID)
Items in tags: listTag names fetched live from Immich
Items in people: listPerson names fetched live from Immich

[!TIP] For albumIds, autocomplete shows human-readable album names but inserts the UUID. This makes it easy to find the right album without needing to copy IDs from the Immich web interface.