Skip to content

Commit

Permalink
Added support for extensions for Python's Markdown, namely the
Browse files Browse the repository at this point in the history
pymdown-extensions introducing the superfences extension, which can be
used to address certain issue, which cannot be handled by handling of
codefences by the Python Markdown implementation out of the box
  • Loading branch information
jonasbn committed Jan 8, 2021
1 parent afd4691 commit 1ae5456
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log for spellcheck-github-actions

## 0.8.0 2021-01-08 feature release, update not required

- Added support for extensions for Python's Markdown, namely the `pymdown-extensions` introducing the `superfences` extension, which can be used to address certain issue, which cannot be handled by handling of codefences by the Python Markdown implementation out of the box

## 0.7.0 2020-12-14 maintenance release, update not required

- Docker image updated to Python 3.9.1 slim via PR #27 from dependabot
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,24 @@ jobs:

This step adds an action, which checkout out the repository for inspection by linters and other actions like this one.

### Diagnostic text: `ERROR: *.md -- 'NoneType' object has no attribute 'end'`

This indicates issues with the Markdown and is reported by `Markdown` (See: [PyPi site](https://pypi.org/project/Markdown/)).

[PySpelling][pyspelling] does however support extension of the standard Markdown parser and you can specify the use of extensions of these are support.

This action support the extensions included in: `pymdown-extensions` (See: [PyPi site](https://pypi.org/project/pymdown-extensions/))

And you can then put these to use in your configuration. The example below outlines the `superfences` extension.

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

Please see the repositorys `requirements.txt` for a list of all included Python modules and their exact versions.

## DockerHub

This action is based on a Docker image available on DockerHub.
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ beautifulsoup4==4.9.3
bracex==2.0.1
html5lib==1.1
lxml==4.6.0
Markdown==3.3.1
pyspelling==2.6.1
PyYAML==5.3.1
six==1.15.0
soupsieve==2.0.1
wcmatch==7.1
webencodings==0.5.1
markdown==3.3.1
pymdown-extensions==8.1

0 comments on commit 1ae5456

Please sign in to comment.