$macdown spell check$

Now we have to add a configuration file for the spelling checker. Uses : rojopolis/spellcheck -github : config_path. On : pull_request : jobs : check-spelling : runs-on : ubuntu -latest github/workflows/spellcheck.yml file in the repository.

We are going to create a new Github workflow to execute the spell check. If you already have a Github workflow configured in your repository and you want to add the spell check to it as another job or step, you can skip this chapter and read the next one directly. So, in this short post we’ll see how to configure a Github action to check the spelling of Markdown documents whenever a pull request is opened on our repository. I personally prefer to add automatic check mechanisms to the continuous integration pipeline that don’t depend on recommendations for local environments. You can avoid typos by checking your spelling locally, using a plugin for the IDE, for example, but it would depend only on you. If the errors are not detected on time, they would impact on our perceived trustworthiness. While it should not be necessary to mention the importance of avoiding spelling mistakes in our docs, it is very common to see comments in code reviews about typos in them. Docs modifications can be reviewed in the same pull request than the code modifications.Docs are kept in plain text, isolated from the format.It is usual to write these docs in Markdown format in the code repository for many reasons, but mainly: How to spell check your docs in a continuous integration pipelineĪs software engineers, we write a lot of documentation (or we should, at least).

Macdown spell check