Vault Glossary

A local‑first glossary for your Obsidian vault.

Vault Glossary lets you create glossary entries from selected text, stores them as Markdown notes, highlights terms across your vault, and supports Ctrl/Cmd‑click to open the entry. Hover previews show the entry content (minus frontmatter).

Features

• Create glossary entries from selected text
• Configurable glossary folder
• Auto‑highlight glossary terms across notes
• Ctrl/Cmd‑click to open the glossary entry
• Hover preview of glossary entry content
• Acronym detection + case rules

How it works

Each glossary entry is a Markdown note in your glossary folder.
The plugin builds an index of terms and highlights matches in editors.

• Frontmatter word overrides filename as the term
• Acronyms can preserve case
• Non‑acronyms can be normalized

Settings

• Glossary folder path
• Automatically infer acronyms
• Enable hover preview
• Hover preview delay (ms)

Installation (manual)

1. Build the plugin:

   npm run build
   

2. Copy these files into your vault:

   • main.js
   • manifest.json
   • styles.css

Place them in:

<Vault>/.obsidian/plugins/vault-glossary/

Development

npm install
npm run dev

Reload Obsidian to see changes.

License

This project is released under The Unlicense (public domain).

Support

If you’d like to support development, use the funding link in manifest.json.