Skip to content

Commit

Permalink
Updated documentation with information on codefences (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed Nov 22, 2022
1 parent 02a7c59 commit a743260
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Expand Up @@ -421,6 +421,39 @@ matrix:

And `code` and `pre` sections are ignored by the spelling check.

Code fences in Markdown require additional configuration using the Markdown extension: `pymdownx.superfences`:

```yaml
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences:
```

A complete example could look as follows:

```yaml
matrix:
- name: Markdown
aspell:
lang: en
dictionary:
wordlists:
- .wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- '**/*.md'
default_encoding: utf-8
```

### Getting Your Action Updated Automatically

The _awesome_ tool dependabot lets you scan your used GitHub Marketplace Actions and lets you know if they are in need of an update.
Expand Down

0 comments on commit a743260

Please sign in to comment.