igsekor / pyspelling-any

Repository is created for the support of any languages that you need for spell checking in Github Actions
MIT License
8 stars 5 forks source link

Please add example for .spellcheck.yml #2

Open antonpatsev opened 2 years ago

antonpatsev commented 2 years ago

Please add example for .spellcheck.yml

MrHinsh commented 1 year ago

Without a sample its pretty difficult to implement.

Here is a sample from this repo but I have no idea what the options are!

matrix:
- name: Markdown
  sources:
  - '**/*.md'
  default_encoding: utf-8
  aspell:
    lang: en
  dictionary:
    wordlists:
    - wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
      comments: false
      ignores:
      - code
      - pre
jonasbn commented 1 year ago

Hi @antonpatsev and @MrHinsh

This is the configuration file for pyspelling, the documentation is available here.

igsekor commented 2 months ago

Meanwhile I'll add detailed documentation to the repo as well.