Skip to main content
Version: 2.3.0

Local vault source

The local source type allows you to display images stored directly in your Obsidian vault.

Configuration​

To use a local source, set the type to local and provide the path to the folder or file relative to your vault root.

FieldTypeDefaultDescription
typestring—Required. Must be local.
pathstring—Required. Vault-relative path to folder or file.
recursivebooleantrueInclude images in subfolders.

Examples​

Display all images in a folder:

```obs-gallery
sources:
- type: local
path: Photos/Vacation2024
view:
type: thumbnail
```

Recursive scan​

Include images from all subfolders by setting recursive: true on your local source configuration:

```obs-gallery
sources:
- type: local
path: Projects
recursive: true
view:
type: grid
```

Single file​

Point directly at one image file path:

```obs-gallery
sources:
- type: local
path: Assets/cover.png
view:
type: thumbnail
```