Expander
Sébastien Dubois89 downloadsReplace variables across your vault using HTML comment markers. Supports static values and dynamic functions.
- Overview
- Scorecard
- Updates6
Replace variables across your Obsidian vault using HTML comment markers. Configure key-value pairs in settings, and Expander will automatically substitute them throughout your notes, and keep those updated too.
Features
- Variable Replacement: Define key-value pairs that get expanded throughout your vault
- Dynamic Values: Use function expressions like
now().format("YYYY-MM-DD")for dynamic content - Update Modes: Control when expansions update
- Auto: Updates automatically on file changes
- Manual: Updates only via command or button
- Once: Updates once, then never again
- Once-and-Eject: Updates once, removes markers
- Folder Filtering: Choose which folders to scan or ignore
- Visual Feedback: Mode badges and refresh buttons in the editor
- Commands: Replace values in current note or entire vault, add new expansion, ...
Installation
Community plugins (recommended)
- In Obsidian, go to Settings → Community plugins.
- Disable Restricted mode if it's enabled.
- Select Browse, search for Expander, install it, then enable it.
You can also browse the catalog on the Obsidian Community website.
Manual installation
If the plugin isn't listed in the community catalog yet (or you want a specific version):
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Copy them into
<Vault>/.obsidian/plugins/expander/. - Reload Obsidian and enable Expander in Settings → Community plugins.
BRAT (bleeding edge)
BRAT (Beta Reviewers Auto-update Tool) installs plugins straight from a GitHub repo and keeps them updated automatically. Use this if you want the latest commits — things might break.
- Install Obsidian42 - BRAT from Settings → Community plugins → Browse and enable it.
- Run BRAT: Add a beta plugin for testing from the command palette.
- Paste
https://github.com/dsebastien/obsidian-expander. - Select the latest version and confirm.
- Enable Expander in Settings → Community plugins.
Quick Start
- Install the plugin (see Installation above).
- Open Settings → Expander
- Add a replacement (e.g., key:
today, value:now().format("YYYY-MM-DD")) - In your note, add:
<!-- expand: today --> - The value and closing tag will be automatically inserted
Syntax
Just add an opening tag - the closing tag is added automatically:
<!-- expand: key -->
After expansion:
<!-- expand: key -->value<!---->
Update mode variants:
<!-- expand: key -->- Auto mode (updates on file change)<!-- expand-manual: key -->- Manual mode (update via command only)<!-- expand-once: key -->- Once mode (fills once, never updates)<!-- expand-once-and-eject: key -->- Once-and-eject mode (fills once, removes markers)
Functions
Dynamic values using function expressions:
| Function | Description | Example |
|---|---|---|
now() |
Current date/time | now().format("YYYY-MM-DD") |
today() |
Today at midnight | today().format("MM/DD/YYYY") |
format(pattern) |
Format date | now().format("HH:mm") |
lower() |
Lowercase | now().format("MMMM").lower() |
upper() |
Uppercase | now().format("MMMM").upper() |
trim() |
Trim whitespace | |
replace(old, new) |
Replace text | replace("-", "/") |
Documentation
Full documentation available at docs/.
Development
See DEVELOPMENT.md for build instructions, testing setup, and contribution guidelines.
Support
If you find this plugin useful, consider supporting my work:
License
MIT License - see LICENSE for details.
News & Updates
To stay up to date about this plugin, Obsidian in general, Personal Knowledge Management and note-taking:
- Subscribe to my newsletter
- Follow me on X/Twitter
Author
Created by Sébastien Dubois (@dSebastien)