Gallery View

by mkshp-dev
5
4
3
2
1
Score: 55/100

Description

Create interactive image galleries in notes using simple obs-gallery code blocks. Display folder or file images as responsive thumbnail grids, carousels, or masonry layouts with click-to-expand modal viewing, lazy loading for large collections, and graceful fallbacks.

Reviews

No reviews yet.

Stats

8
stars
5,509
downloads
2
forks
139
days
1
days
1
days
134
total PRs
0
open PRs
3
closed PRs
131
merged PRs
91
total issues
0
open issues
91
closed issues
412
commits

Latest Version

2 days ago

Changelog

  • Galleries in Live Preview: A note with several galleries could show one of them as an empty line in Live Preview, while Reading view showed it. Rendering one gallery no longer removes another gallery that Obsidian has not placed on the page yet.

Thank you @janglad for the PR

README file from

Github

Turn any folder of photos into a gallery inside your notes. Pick a layout (masonry, justified rows, a mosaic, thumbnails, a carousel or full-width embeds), click a photo to see it full screen, and pull images from your vault, the web, Immich or Nextcloud.

Downloads Version Obsidian

Install in Obsidian

A justified photo gallery in an Obsidian note, opening a photo in the full-screen viewer

Features

The same folder of photos in masonry, justified, mosaic, thumbnail, carousel and embed layouts

  • Six layouts. Masonry columns, justified rows (like Google Photos or Immich), a mosaic of large and small tiles (draw your own patterns, blank spaces included), a thumbnail grid, a carousel and borderless embeds. Switch by changing one word.
  • Full-screen viewer. Click any photo for a dark, distraction-free view with slideshow, zoom, photo details, keyboard arrows and swipe.
  • Your photos, wherever they are. Vault folders (including subfolders and paths relative to the note), web URLs, Immich (shared links, or your library with albums, people, tags and dates) and Nextcloud (share links or WebDAV folders).
  • No YAML needed. The Insert gallery command builds the block for you, Build custom mosaic lets you draw mosaic patterns on a grid, and autocomplete helps if you'd rather type it.
  • Fast with big folders. Images load as you scroll, with optional pagination.
  • Fits your notes. Uses your theme, works on mobile, and can drop its frame so the gallery sits in the text.
  • Ready for Publish (experimental). Obsidian Publish can't run plugins, so Burn galleries in this note turns a note's galleries into images of how they look, ready to publish.

Full-screen image viewer with the details panel open

Quick start

Install

In Obsidian, open Settings → Community plugins → Browse, search for Gallery View, then install and enable it. Or open it in Obsidian.

  1. Download main.js, manifest.json and styles.css from the latest release.
  2. Create the folder YourVault/.obsidian/plugins/gallery-view/ and copy the files into it.
  3. Enable Gallery View in Settings → Community plugins.

Try it in 30 seconds

Run Gallery View: Create showcase notes from the command palette. It creates a GalleryDemo/ folder with ready-made notes for every layout and source, including use cases built on real photos.

Make your own

Run Gallery View: Insert gallery, pick a layout and a folder, and click Insert gallery block:

Building a masonry gallery with the Insert gallery command

Basic Usage

Create galleries in your notes using code blocks:

```obs-gallery
sources:
  - type: local
    path: Images/Screenshots
view:
  type: thumbnail
```

[!NOTE] The plugin fully supports the legacy v1 syntax (e.g., path: Images/Screenshots) for backward compatibility, but the v2 nested sources schema is preferred.

Documentation

For full details on configuring the plugin, usage examples, and available settings, please refer to the Gallery View documentation.

Supported formats

  • JPEG (.jpg, .jpeg)
  • PNG (.png)
  • GIF (.gif)
  • WebP (.webp)
  • AVIF (.avif)
  • SVG (.svg): scaled to fill the viewer, since it's a vector
  • Videos (.mp4, .m4v, .webm, .mov, .ogv) from your vault, Immich, Nextcloud and external URLs: shown as a still frame with a play badge, and played in the full-screen viewer

Showcase Generator

Gallery View includes a built-in command to generate a set of interactive demo notes inside your vault. This is the fastest way to see what the plugin can do and to learn the configuration syntax.

  1. Open the Obsidian command palette (Ctrl+P / Cmd+P)
  2. Run Gallery View: Create showcase notes
  3. Choose whether to add the read-only demo server connections (see below), or create the notes only.
  4. Open the generated GalleryDemo/ folder in your vault to explore working examples of local sources, external URLs, every view, and Immich and Nextcloud sources backed by public demo servers.

Network use

Gallery View only makes network requests for sources you configure, or for demo notes you choose to create:

  • Your own sources: external, immich, immich-share, nextcloud and nextcloud-share sources contact the server in their URL or connection. External image URLs load only when Allow remote images is on.
  • Demo servers: the showcase notes for Immich and Nextcloud load photos from public, read-only demo servers run by the plugin's author (demo-immich.mkshp.dev and demo-nextcloud.mkshp.dev). Create showcase notes asks before adding their connections to your settings. When those notes are open, your IP address reaches that server; access logs are kept for about 14 days. See Try it with the demo servers.
  • Sample web images: the showcase's External URLs and Mixed sources notes load sample images from picsum.photos when Allow remote images is on.
  • Sample photos (optional): Create showcase notes and Create use-case notes can download a set of 39 sample photos (about 10 MB) for the use-case notes from docs.mkshp.dev, the documentation site. This happens once, only when you run one of those commands and leave Download sample photos on in the dialog; the photos are then saved in your vault under GalleryDemo/Use cases/_photos/. See Use cases.

The plugin has no telemetry and sends nothing anywhere else.

Development

Building from Source

# Install dependencies
npm install

# Development build with watching
npm run dev

# Production build
npm run build

# Simple build (MVP version)
npm run build-mvp

Project Structure

obsidian-gallery-plugin/
├── main.js              # Compiled plugin
├── manifest.json        # Plugin metadata
├── styles.css           # Gallery styling
├── package.json         # Dependencies
├── tsconfig.json        # TypeScript config
└── src/                 # Source code
    ├── main.ts          # Main plugin code, lifecycle management
    ├── models/          # Data models
    ├── views/           # View components
    ├── services/        # Core services
    └── processors/      # Content processing

Contributing

Contributions are welcome! Please feel free to:

  • Share usage examples and feedback
  • Help with documentation

Development Setup

  1. Clone the repository
  2. Run npm install to install dependencies
  3. Use npm run dev for development with auto-rebuilding
  4. Test in your Obsidian vault

License

MIT License — see LICENSE for details.

Acknowledgments

Support

If this project helps your workflow, consider supporting its development with a ☕