README file from
GithubHunspell Spellchecker for Obsidian
A high-performance, offline spellchecker for Obsidian using standard Hunspell dictionaries (.aff and .dic files).
Features
- Offline by Design: All spellchecking happens locally on your device. No data is ever sent to external servers.
- Multiple Languages: Download and manage multiple language dictionaries directly within the plugin settings.
- Performance: Optimized to run smoothly even on large documents without causing typing lag.
- Personal Dictionary: Add custom words via right-click to prevent them from being flagged in the future.
- Ignored Words: Temporarily ignore words within your vault.
- Smart Capitalization: The plugin now respects the original capitalization of words added to your personal dictionary or ignored words list.
- Interactive Status Bar:
- Quickly see the active language.
- View the number of misspelled words currently visible on your screen.
- Click the active language to open settings.
- Click the error count (🔴) to see a dropdown list of misspelled words. Click any word in the list to jump directly to it in your text!
Installation
From Obsidian Community Plugins
- Open Obsidian Settings.
- Go to Community plugins and turn off "Safe mode".
- Click Browse and search for "Hunspell Spellchecker".
- Install and enable the plugin.
Manual Installation
- Download the latest release from the Releases page.
- Extract the contents (
main.js,manifest.json,styles.css) into your vault's.obsidian/plugins/obsidian-hunspell-spellcheckerfolder. - Reload Obsidian and enable the plugin in Settings > Community plugins.
Usage
- Open the plugin settings.
- Scroll to Download Languages and click "Fetch available languages".
- Find your desired language in the list and click Install.
- Once installed, select it from the Active language dropdown at the top.
- Misspelled words will now have a red squiggly line underneath them.
- Right-click a misspelled word to see suggestions, add it to your dictionary, or ignore it.
Contributing
Contributions, issues, and feature requests are welcome!
License
MIT License