Skip to content

trey-wallis/obsidian-vault-explorer

Repository files navigation

Obsidian Vault Explorer

Vault Explorer is an Obsidian.md plugin for desktop only. It allows you to explore your vault in visual format.

This plugin is a replacement for some of the functionality found in Obsidian DataLoom.

About

Installation

  1. Install the Obsidian BRAT plugin from Obsidian community plugin store
  2. Enable the plugin
  3. Open the plugin settings
  4. Click Add beta plugin
  5. Enter the repository url: https://github.com/trey-wallis/obsidian-vault-explorer
  6. Click Add plugin

Usage

Start by opening the vault explorer view by clicking on the compass icon on the left-hand sidebar.

The explorer vault is a read-only view for your vault. You may filter based on folders and property values.

There are also additional views by which you can view your vault files.

Settings

The vault explorer has several built-in properties.

URL

The url property will render a button in the grid view that will allow you to navigate to URL pages.

A url should be a valid url e.g. https://google.com

Favorite

The favorite property will allow you to filter by favorites using the Favorites checkbox.

This property should be of checkbox type.

Development

  1. Clone the GitHub repository
git clone https://github.com/trey-wallis/obsidian-vault-explorer.git
  1. Install Bun
  2. Build the project bun run build
  3. Add a symbolic link from the dist folder to your vault's plugin folder
ln -s <folder-path>/obsidian-vault-explorer/dist <vault-path>/.obsidian/plugins/vault-explorer
  1. Enable the plugin