mirror of
https://github.com/ChainSafe/lodestar.git
synced 2026-01-06 22:33:59 -05:00
9e57b7d320
* Check docs spelling * Add config * Fix docs spelling * Lint docs format * docs(flamegraph): remove note about script that was removed * sort wordlist * Set sort algo * Fix CI pipeline * hope to fix CI ordering * Disable wordlist sort check * docs(CONTRIBUTING): remove merge conflict marker and add codeblock types * refactor: change to pyspelling.yml for local runs * docs: make spell-checking wordlist case insensitive * fix: sort .wordlist.txt * refactor: alphabetize script order * fix: add docs/reference to gitignore * docs: add codeblocks to pyspelling ignore and clear all errors * docs: ignore possessive endings in spellcheck * docs: clear spelling errors in package readmes * docs: pyspelling fix generated cli.md * feat(workflows): lint generated docs * feat(workflows): add word sort to docs-check * test: unsort wordlist * fix: sort wordlist * refactor(workflow): remove unused comments --------- Co-authored-by: matthewkeil <me@matthewkeil.com> Co-authored-by: Cayman <caymannava@gmail.com>
42 lines
1.1 KiB
YAML
42 lines
1.1 KiB
YAML
matrix:
|
|
- name: markdown
|
|
aspell:
|
|
lang: en
|
|
ignore-case: true
|
|
dictionary:
|
|
wordlists:
|
|
- .wordlist.txt
|
|
pipeline:
|
|
- pyspelling.filters.url:
|
|
- pyspelling.filters.markdown:
|
|
markdown_extensions:
|
|
- pymdownx.superfences:
|
|
- pymdownx.highlight:
|
|
- pymdownx.striphtml:
|
|
- pymdownx.magiclink:
|
|
- pyspelling.filters.url:
|
|
- pyspelling.filters.html:
|
|
comments: false
|
|
ignores:
|
|
- code
|
|
- pre
|
|
- pyspelling.filters.context:
|
|
context_visible_first: true
|
|
delimiters:
|
|
# Ignore possessive endings
|
|
- open: '(?<=\w)''s(?!\w)'
|
|
close: '\b'
|
|
# Ignore eth methods (e.g. eth_estimateGas)
|
|
- open: '(?:\s)eth_(?:\w*)'
|
|
close: '\s'
|
|
# Ignore flags in cli.md
|
|
- open: '--(?:\w*)'
|
|
close: '[^\w]'
|
|
# Ignore hex strings
|
|
- open: '0x[a-fA-F0-9]'
|
|
close: '[^a-fA-F0-9]'
|
|
sources:
|
|
- "docs/**/*.md"
|
|
- "CONTRIBUTING.md"
|
|
- "README.md"
|
|
- "packages/*/README.md" |