From 59de6644613e4ce96cf6b5a8412f266a9e10a3f5 Mon Sep 17 00:00:00 2001
From: bl-ue <54780737+bl-ue@users.noreply.github.com>
Date: Mon, 22 Mar 2021 13:01:59 -0400
Subject: [PATCH] codespell: add page (#5472)

---
 pages/common/codespell.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 pages/common/codespell.md

diff --git a/pages/common/codespell.md b/pages/common/codespell.md
new file mode 100644
index 0000000000..b4be51b454
--- /dev/null
+++ b/pages/common/codespell.md
@@ -0,0 +1,36 @@
+# codespell
+
+> Spellchecker for source code.
+> More information: <https://github.com/codespell-project/codespell>.
+
+- Check for typos in all text files in the current directory, recursively:
+
+`codespell`
+
+- Correct all typos found in-place:
+
+`codespell --write-changes`
+
+- Skip files with names that match the specified pattern (accepts a comma-separated list of patterns using wildcards):
+
+`codespell --skip "{{pattern}}"`
+
+- Use a custom dictionary file when checking (`--dictionary` can be used multiple times):
+
+`codespell --dictionary {{path/to/file.txt}}`
+
+- Do not check words that are listed in the specified file:
+
+`codespell --ignore-words {{path/to/file.txt}}`
+
+- Do not check the specified words:
+
+`codespell --ignore-words-list {{words,to,ignore}}`
+
+- Print 3 lines of context around, before or after each match:
+
+`codespell --{{context|before-context|after-context}} {{3}}`
+
+- Check file names for typos, in addition to file contents:
+
+`codespell --check-filenames`