Improve docs
All checks were successful
Build on Push and create Release on Tag / build (push) Successful in 52s

This commit is contained in:
MassiveBox 2025-10-10 12:28:38 +02:00
parent 631cfd14bf
commit dce511ae97
Signed by: massivebox
GPG key ID: 9B74D3A59181947D
2 changed files with 6 additions and 3 deletions

View file

@ -10,7 +10,10 @@ This plugin adds a fully featured grammar and spell checker for SiYuan, powered
4. Right-click over an underlined word (or click the Menu keyboard button), hover on "Plugin", then... 4. Right-click over an underlined word (or click the Menu keyboard button), hover on "Plugin", then...
- Click the error message to get a detailed explanation of the error - Click the error message to get a detailed explanation of the error
- Click "Add to dictionary" to permanently ignore the error - Click "Add to dictionary" to permanently ignore the error
- Click any of the corrections to apply them - Click any of the corrections to apply them
> If, at any point, the underlines are not displayed correctly under the words, click on the currently active tab in
SiYuan's tab selector or Document Tree, this will trigger a refresh of the underlines.
## ☑️ Features ## ☑️ Features
- [x] Spell checker - [x] Spell checker

View file

@ -50,11 +50,11 @@
}, },
"offline": { "offline": {
"title": "Offline mode", "title": "Offline mode",
"description": "If enabled, the plugin will use a local spell checker, which is faster and more privacy friendly, but doesn't provide advanced grammar checking" "description": "If enabled, the plugin will use a local spell checker, which is more privacy friendly and works without internet, but doesn't provide advanced grammar checking and may slow SiYuan down when a large note is being loaded."
}, },
"offlineDicts": { "offlineDicts": {
"title": "Offline dictionaries", "title": "Offline dictionaries",
"description": "Comma-separated list of dictionaries used for offline spell checking. <a href='https://github.com/wooorm/dictionaries/tree/main/dictionaries'>Available options</a>. Example: <code>en,it</code>" "description": "Comma-separated list of dictionaries used for offline spell checking. <a href='https://github.com/wooorm/dictionaries/tree/main/dictionaries'>Available options</a>. Example: <code>en,it</code><br>Set your primary language as first, and don't include unneeded languages, as they will only use more resources."
} }
}, },
"errors": { "errors": {