README file from
GithubVault Dictionary
Vault Dictionary is an Obsidian plugin that automatically highlights and displays definitions for specific words throughout your notes. It enables you to build a personal dictionary and seamlessly view definitions for matching words in both Live Preview and Reading Mode.
Features
- Automatic Highlighting: Automatically highlights words found in your dictionary across your vault without needing manual links.
- Live Preview & Reading Mode: Works seamlessly whether you are actively editing your notes in Live Preview or viewing them in Reading Mode.
- Quick Add: Select any text, right-click, and choose "Add to Dictionary" to quickly define a new term.
- Settings Dashboard: Easily manage your dictionary entries, search for specific terms, edit descriptions, and sort them directly from the plugin settings.
- JSON Storage: Your dictionary is safely stored in
.obsidian/vault-dictionary.json, allowing for easy manual editing, syncing, and backups.
Usage
- Adding Words: You can add entries from Settings > Vault Dictionary or by selecting any text in your editor, right-clicking, and selecting Add to Dictionary.
- Viewing Definitions: Once added, the words will be automatically highlighted in your notes.
- Refreshing: If you manually edit the
vault-dictionary.jsonfile outside of Obsidian, you can use the Refresh Dictionary command from the Command Palette to apply changes instantly.