Documentation

Typo CI checks Pull Requests for spelling mistakes every time you push your code up to GitHub.

To configure how Typo CI will behave when checking your code, you can add a .typo-ci.yml file to the root of your project. Typo CI will look for this file on your PRs branch.

Below is a sample file:

# This is a sample .typo-ci.yml file, it's used to configure how Typo CI will behave.
# Add it to the root of your project and push it to github.
---

# What language dictionaries should it use? Currently Typo CI supports:
# de
# en
# en_GB
# en_CA
# en_AU
# en_ZA
# es
# fr
# is
# it
# pt
# pt_BR
# sw
dictionaries:
  - en
  - en_GB

# Any files/folders we should ignore?
excluded_files:
  - "vendor/**/*"
  - "node_modules/**/*"
  - "*.key"
  - "*.enc"
  - "*.min.css"
  - "*.css.map"
  - "*.min.js"
  - "*.js.map"
  - "package-lock.json"
  - "yarn.lock"
  - "Gemfile.lock"
  - ".typo-ci.yml"

# Any typos we should ignore?
excluded_words:
  - typoci