From dce511ae97b93f97145581f1fbd6cca254229a96 Mon Sep 17 00:00:00 2001 From: MassiveBox Date: Fri, 10 Oct 2025 12:28:38 +0200 Subject: [PATCH] Improve docs --- README.md | 5 ++++- public/i18n/en_US.json | 4 ++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fc292c7..ad35461 100644 --- a/README.md +++ b/README.md @@ -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... - Click the error message to get a detailed explanation of 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 - [x] Spell checker diff --git a/public/i18n/en_US.json b/public/i18n/en_US.json index fab8ed4..1e4a48f 100644 --- a/public/i18n/en_US.json +++ b/public/i18n/en_US.json @@ -50,11 +50,11 @@ }, "offline": { "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": { "title": "Offline dictionaries", - "description": "Comma-separated list of dictionaries used for offline spell checking. Available options. Example: en,it" + "description": "Comma-separated list of dictionaries used for offline spell checking. Available options. Example: en,it
Set your primary language as first, and don't include unneeded languages, as they will only use more resources." } }, "errors": {