From cb898bcf75da0dc19a7f0189e365ccbf5e223026 Mon Sep 17 00:00:00 2001 From: Riccardo Ferretti Date: Tue, 13 Sep 2022 12:16:04 +0200 Subject: [PATCH] Removed "Spell Right" from list of recommended extensions --- .vscode/extensions.json | 5 +---- docs/features/spell-checking.md | 18 +++++------------- getting-started.md | 3 +-- 3 files changed, 7 insertions(+), 19 deletions(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 7b74b17..dd94008 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -9,9 +9,6 @@ "yzhang.markdown-all-in-one", // Image-pasting for markdown - "mushan.vscode-paste-image", - - // Spell checking for text, markdown and latex - "ban.spellright", + "mushan.vscode-paste-image" ] } diff --git a/docs/features/spell-checking.md b/docs/features/spell-checking.md index 7fd08b0..71a3106 100644 --- a/docs/features/spell-checking.md +++ b/docs/features/spell-checking.md @@ -1,17 +1,9 @@ # Spell Checking -Foam comes with a spell checker. - -Misspelled words are highlighted, like hellow. -You can place the cursor on top of the word, and press `cmd+.` for suggestions on how to fix the problem. - -You can configure the extension in the settings, for example to: - -- ignore certain files -- change the language(s) -- and much more - -For more information go to the [Spellright extension page](https://marketplace.visualstudio.com/items?itemName=ban.spellright). - There are many spell checking extensions for VS Code. + +The most popular spell checker for VS Code is [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker). + Another one of our favorites is [LTeX](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#overview), which is a bit heavier but offers some extra functionality. + +Another popular one is [Spellright](https://marketplace.visualstudio.com/items?itemName=ban.spellright), but be mindful that there have been reports of incompatibility with the `vscode-markdown` extension (see https://github.com/foambubble/foam/issues/1068). diff --git a/getting-started.md b/getting-started.md index abdabb5..f78462f 100644 --- a/getting-started.md +++ b/getting-started.md @@ -14,7 +14,7 @@ Let's go through this to set up your repo: - [ ] #tags can be used to further organize your content. Look at the `Tag Explorer` view on the left panel to find and navigate the tags in your knowledge base. See [[tags-and-tag-explorer]]. -- [ ] Foam supports [[spell-checking]]. +- [ ] Foam supports [[spell-checking]] via VS Code. - [ ] You can also paste images in your Foam, just press `cmd+alt+v` to create the image file and link to it from your note. See [[paste-images-from-clipboard]]. @@ -44,7 +44,6 @@ Here they are: - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) - [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) -- [spellright](https://marketplace.visualstudio.com/items?itemName=ban.spellright) A special mention goes to [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links) and [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) which have now been replaced by our own implementation but were foundational to Foam's beginnings.