Spell checking Markdown documents using a Github action

• spellcheck-github-actions

  23 129 6.9 Shell

  Spell check action

Now we have to add a configuration file for the spelling checker. It uses PySpelling under the hood. When checking Markdown files, it first converts a Markdown text file's buffer using Python Markdown and returns a single SourceText object containing the text as HTML. Then it captures the HTML content, comments, and even attributes and performs the check. It has a lot of configuration options, but here we are going to see only an example with some basics. For further info you can read the docs of the rojopolis/spellcheck-github-actions Github action.

• personal-website

  1 0 0.0 JavaScript

  Personal website built with Gatsby (by javierbrea)

This blog is being checked with the examples provided in this post, because it is generated from Markdown files, so you can get the code of the examples directly from https://github.com/javierbrea/personal-website.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• Python-Markdown

  15 3,578 8.0 Python

  A Python implementation of John Gruber’s Markdown with Extension support.

  

Now we have to add a configuration file for the spelling checker. It uses PySpelling under the hood. When checking Markdown files, it first converts a Markdown text file's buffer using Python Markdown and returns a single SourceText object containing the text as HTML. Then it captures the HTML content, comments, and even attributes and performs the check. It has a lot of configuration options, but here we are going to see only an example with some basics. For further info you can read the docs of the rojopolis/spellcheck-github-actions Github action.

• pyspelling

  5 78 6.1 Python

  Spell checker automation tool

Now we have to add a configuration file for the spelling checker. It uses PySpelling under the hood. When checking Markdown files, it first converts a Markdown text file's buffer using Python Markdown and returns a single SourceText object containing the text as HTML. Then it captures the HTML content, comments, and even attributes and performs the check. It has a lot of configuration options, but here we are going to see only an example with some basics. For further info you can read the docs of the rojopolis/spellcheck-github-actions Github action.

Suggest a related project