Attempt to skip code in misspell (#17335)

* Attempt to skip code in misspell

* Changed a readme.md containing odd words to see if filtering works

* Escape a md file and try to ignore hyperlink content in spellcheck

* More escaping for code in mbedos_commissioning.md

* Add instructions for local spelling run

* More updates to make spell checker happy

* Cleanup some image logic in mbed unit test files

* More updates for spelling - move code blocks into code blocks

* More paths updates for lwip patch readme

* Restyle

* update for allow language in 3 backticks, replaced a lot of mbedos logo pictures

* Code and image block updates on guides

* Updating several nrf files for code blocks

* update k32w android doc for code blocks

* Code blocks for several readmes

* Code blocks for some silabs and esp32

* Code blocks

* More code blocks

* More code blocks

* More code blocks

* More code blocks

* More code blocks

* Roll back some of the wordlist - this takes too long. Just fix some super obvious ones and have some code improvements

* Restyle

* Fix misplaced backtick

Author: andy31415

.github/.wordlist.txt

@@ -8,7 +8,6 @@
 21
 22
 AAAA
-aabbccddeeff
 aarch
 abcdef
 abfb
@@ -510,7 +509,6 @@ ffeebaefa
 FFF
 fffe
 fffff
-fHtcwcAAAAAAAAAwQAAAAAAXPMlAAAAAAA
 Fi
 filepath
 fini
@@ -1392,17 +1390,13 @@ xAAAA
 xab
 xaver
 xb
-xBEEF
 xbef
 xc
 xcd
 Xcode
 xcodeproj
 xcworkspace
 xd
-xDEAD
-xDEADBEEF
-xdeadbeefcafe
 xds
 xdsdfu
 xEA
@@ -1420,15 +1414,8 @@ xFF
 xFFF
 xFFFF
 xfffff
-xFFFFFFFD
-xffffffffe
-xfffffffff
-xffffffffffff
-xffffffffffffXXXX
 xtensa
 xwayland
-XXXX
-XXXXXXXX
 xyz
 xz
 xzvf
@@ -1439,7 +1426,6 @@ YNJV
 Yocto
 yoctoproject
 YourFolder
-yWsC
 zapt
 zaptool
 ZCL

.spellcheck.yml

@@ -12,12 +12,53 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# To run locally:
+#   Prerequisits (only once):
+#
+#      apt-get install aspell aspell-en
+#      pip install pyspelling
+#
+#   Actual run:
+#
+#      pyspelling pyspelling --config .spellcheck.yml
+
 matrix:
   - name: markdown
     dictionary:
       wordlists:
         - .github/.wordlist.txt
     pipeline:
+      # See https://facelessuser.github.io/pyspelling/configuration/#pipeline
+      # and https://facelessuser.github.io/pyspelling/filters/context/
+
+      # context-aware logic: we have a LOT of code examples in markdown,
+      # avoid trying to spellcheck code.
+      - pyspelling.filters.context:
+          context_visible_first: true
+          escapes: \\[\\`~]
+          delimiters:
+          # Ignore multiline content between fences (fences can have 3 or more back ticks)
+          # ```
+          # content
+          # ```
+          #
+          # Allows language marker (since github allows it) like:
+          # ```python
+          # content
+          # ```
+          - open: '(?s)^(?P<open> *`{3,})[a-z]*$'
+            close: '^(?P=open)$'
+          # Ignore text between inline back ticks
+          - open: '(?P<open>`+)'
+            close: '(?P=open)'
+          # Ignore URL in hyperlinks [title](url)
+          - open: '\[[^]]*\]\('
+            close: '\)'
+          # Ignore code markers
+          - open: '<code>'
+            close: '</code>'
+
+      # converts markdown to HTML
       - pyspelling.filters.markdown:
     sources:
       - '**/*.md|!third_party/**|!examples/common/**/repo/**'