Merge pull request #244 from Isengo1989/docs/add-relaxed-header-info

Docs/add relaxed header info

Author: jonasbn

README.md

@@ -28,6 +28,7 @@ This action uses [PySpelling][pyspelling] to check spelling in source files in t
   - [Extra Configuration](#extra-configuration)
     - [Extra Configuration for PySpelling](#extra-configuration-for-pyspelling)
     - [Extra Configuration for Markdown](#extra-configuration-for-markdown)
+      - [Extra Configuration for Superfences](#extra-configuration-for-superfences)
 - [Spellcheck Configuration File](#spellcheck-configuration-file)
   - [Predefined Name](#predefined-name)
 - [Specifying Number of Jobs for Parallel Processing](#specifying-number-of-jobs-for-parallel-processing)
@@ -305,6 +306,18 @@ Currently only the case of use of `superfences` has been requested as outlined i
 
 Do also see the Diagnostics sections below, demonstrating diagnostics emitted from [Python Markdown][markdown], which might require the use of an extension.
 
+##### Extra Configuration for Superfences
+
+Some statis site generators like Vitepress or Docusaurus use the code fence line for extra information, for example line highlighting or code block headlines. Superfencing
+would break here and spelling would be checked in the specific code section. To avoid this you can set the `relaxed_headers` option to `true`.
+
+```yaml
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - pymdownx.superfences:
+          relaxed_headers: true
+```
+
 ## Spellcheck Configuration File
 
 You can either provide a path to the configuration file or save a file in the root of your repository with a predefined name (list below). If `config_path` is provided then it will be used and the other configuration options will be ignored. If `config_path` is not provided then the repository is searched after a first match