vschroeter / obsidian-glossary

Plugin for obsidian to show explanations for abbreviations defined in an extra abbreviations file.

Obsidian Glossary Plugin

This plugin automatically links your glossary / abbreviation entries, which you have defined in an special glossary folder.

• no manual linking necessary
• links do not appear in graph view & reference counting
• updates the links automatically while you expand your glossary folder

Usage

• In the settings, define the name of your glossary folder (defaults to Glossary) and add this folder to your vault.
• For each glossary / abbreviation entry add a new file. This file is exactly like normal files, you can add short or detailed descriptions for this entry.
• In read mode, all found glossary entries will be automatically linked, thus you can preview them by hovering.

Manually installing the plugin

• Copy over main.js, styles.css, manifest.json (find them under Releases) to your vault VaultFolder/.obsidian/plugins/obisidian-glossary/.

How to use for development

• Clone this repo.
• npm i or yarn to install dependencies
• npm run dev to start compilation in watch mode.

It is recommended to use the Hot Reload Plugin for development.

Roadmap

• Glossaries can be overwritten by nested glossary folders
• Support aliases and case-insensitivity for glossary entries
• Add glossary entry preview in live preview mode

obsidian-glossary's Issues

glossary case-sensitivity

Currently the glossary only links to words/phrases with the same case, would it be possible to alter it or add an option to allow case-insensitive auto-linking? e.g.

Also it doesn't link if there are symbols in front of the word/phrase like if you try to italicize a word it won't work. e.g.

alias problem

Will it support aliases recognition

I love it!

Just wanted to say thank you!

Hope you'll add the support of Live Preview soon. :)