diff --git a/.github/spellcheck.yml b/.github/spellcheck.yml new file mode 100644 index 000000000..78a04b4c6 --- /dev/null +++ b/.github/spellcheck.yml @@ -0,0 +1,18 @@ +matrix: +- name: Markdown + aspell: + lang: en + dictionary: + wordlists: + - .github/wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - '**/*.md' + default_encoding: utf-8 diff --git a/.github/wordlist.txt b/.github/wordlist.txt new file mode 100644 index 000000000..8a8192dc7 --- /dev/null +++ b/.github/wordlist.txt @@ -0,0 +1,80 @@ +Aard +ABBYY +Almaany +AppleDict +archlinux +ArchLinux +aur +bgl +BGL +CEDICT +cmd +config +csv +CSV +df +Dictd +Dictfile +dictfmt +DictionaryForMIDs +dictunformat +DigitalNK +DIKT +dsl +DSL +dtxt +edlin +EDLIN +epub +EPUB +FreeDict +Gettext +Gobject +Gtk +https +https +ifo +JMDict +json +JSON +jsonl +kedict +Kiwix +kobo +Kobo +ldf +Lingvo +md +MDict +mdx +mids +mobi +Mobipocket +NixOS +openSUSE +po +PyGI +pyglossary +PyGlossary +quickdic +QuickDic +rst +sql +StarDict +Tabfile +tcltk +tei +Termux +Tkinter +txt +ui +UI +Wiktextract +Wordset +www +xdxf +XDXF +xml +Yomichan +zim +Zim \ No newline at end of file diff --git a/.github/workflows/doc-spelling.yml b/.github/workflows/doc-spelling.yml new file mode 100644 index 000000000..f54184bea --- /dev/null +++ b/.github/workflows/doc-spelling.yml @@ -0,0 +1,16 @@ +name: Spellcheck +on: push + +jobs: + build: + name: Spellcheck + runs-on: ubuntu-latest + steps: + # The checkout step + - uses: actions/checkout@v3 + - uses: rojopolis/spellcheck-github-actions@0.34.0 + name: Spellcheck + with: + config_path: .github/spellcheck.yml + +