Skip to content

Commit

Permalink
fix spell check
Browse files Browse the repository at this point in the history
  • Loading branch information
calldelegation committed Oct 4, 2024
1 parent 3d88111 commit 32be34d
Showing 1 changed file with 28 additions and 34 deletions.
62 changes: 28 additions & 34 deletions docs/.spellcheck.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,28 @@
name: Docs

on:
push:
branches:
- master
pull_request:

jobs:
lint-docs:
name: Lint Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: FuelLabs/github-actions/setups/node@master
- name: Lint Check
run: |
pnpm install
pnpm lint:check
markdown-link-check:
name: Check Links
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3
- uses: gaurav-nelson/[email protected]

docs-hub-check:
name: Docs Hub Checks
uses: FuelLabs/github-actions/.github/workflows/mdbook-docs.yml@master
with:
docs-src-path: 'docs/src'
spellcheck-config-path: 'docs/.spellcheck.yml'
matrix:
- name: SPCheck
aspell:
lang: en
dictionary:
encoding: utf-8
wordlists:
- docs/spell-check-custom-words.txt
pipeline:
- pyspelling.filters.context:
context_visible_first: true
escapes: \\[\\`~]
delimiters:
# Ignore all code blocks
- open: '(?s)^(?P<open> *`{3,}\s*(\w+\s*,?\s*)+.*?)$'
close: '^( *`{3,})$'
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- 'docs/src/*.md'
- 'docs/src/**/*.md'
default_encoding: utf-8

0 comments on commit 32be34d

Please sign in to comment.