On , I learnt ...

How to spell-check markdown repos on CircleCI

The tmaier/markdown-spellcheck Docker image wraps node-markdown-spellcheck and can be used locally and on CircleCI to spell-check markdown files.

Locally, run:

$ docker run --rm -ti -v $(pwd):/workdir tmaier/markdown-spellcheck:latest \
    --report --ignore-numbers --ignore-acronyms "**/*.md"

In your .circleci/config.yml file, use:

version: 2.1

jobs:

  spelling:
    docker:
      - image: tmaier/markdown-spellcheck:latest
    steps:
      - checkout
      - run:
          name: Check spelling
          command: mdspell --report --ignore-numbers --ignore-acronyms "**/*.md"

workflows:
  static-analysis:
    jobs:
      - spelling

Thanks to Luke Page for the node library and Tobias L. Maier for the Docker wrapper.