From 9691f5432db7720e2b863594ae212e86046b6d4c Mon Sep 17 00:00:00 2001
From: Riccardo Ferretti <code@riccardoferretti.com>
Date: Fri, 22 Jan 2021 13:49:20 +0100
Subject: [PATCH] added spellright to list of recommended extensions, and added
 to getting started guide

---
 .vscode/extensions.json         |  5 ++++-
 .vscode/settings.json           |  1 +
 .vscode/spellright.dict         |  1 +
 docs/features/spell-checking.md | 13 +++++++++++++
 getting-started.md              |  3 +++
 5 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 .vscode/spellright.dict
 create mode 100644 docs/features/spell-checking.md

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index 1a58a9d..5747da4 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -12,6 +12,9 @@
     "kortina.vscode-markdown-notes",
 
     // Image-pasting for markdown
-    "mushan.vscode-paste-image"
+    "mushan.vscode-paste-image",
+
+    // Spell checking for text, markdown and latex
+    "ban.spellright",
   ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
index ccf7df1..61017e8 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -22,6 +22,7 @@
   "pasteImage.path": "${projectRoot}/attachments",
   "pasteImage.showFilePathConfirmInputBox": true,
   "prettier.singleQuote": false,
+  "spellright.notificationClass": "warning",
   "vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
   "vscodeMarkdownNotes.slugifyMethod": "github-slugger",
   "window.autoDetectColorScheme": true,
diff --git a/.vscode/spellright.dict b/.vscode/spellright.dict
new file mode 100644
index 0000000..226a625
--- /dev/null
+++ b/.vscode/spellright.dict
@@ -0,0 +1 @@
+wikilink
diff --git a/docs/features/spell-checking.md b/docs/features/spell-checking.md
new file mode 100644
index 0000000..3051347
--- /dev/null
+++ b/docs/features/spell-checking.md
@@ -0,0 +1,13 @@
+# Spell Checking
+
+Foam come 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).
diff --git a/getting-started.md b/getting-started.md
index 19e2ad1..180f084 100644
--- a/getting-started.md
+++ b/getting-started.md
@@ -14,6 +14,8 @@ 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]].
+
 - [ ] 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]].
 
 - [ ] You can use Foam for your daily notes, or journaling. Execute now the `Foam: Open Daily Note` command to create a new file in your `journal` folder. See [[daily-notes]].
@@ -49,6 +51,7 @@ A special mention to [Markdown Links](https://marketplace.visualstudio.com/items
 [inbox]: inbox.md "Inbox"
 [graph-visualization]: docs/features/graph-visualization.md "Graph Visualization"
 [tags-and-tag-explorer]: docs/features/tags-and-tag-explorer.md "Tags and Tag Explorer"
+[spell-checking]: docs/features/spell-checking.md "Spell Checking"
 [paste-images-from-clipboard]: docs/how-to/paste-images-from-clipboard.md "Paste Images from Clipboard"
 [daily-notes]: docs/features/daily-notes.md "Daily Notes"
 [todo]: todo.md "Todo"