-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3d88111
commit 32be34d
Showing
1 changed file
with
28 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |