Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
23 changed files
with
602 additions
and
226 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 |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Check docs | ||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
paths: | ||
- "docs/**" | ||
- "index.md" | ||
- ".spellcheckwordlist.txt" | ||
- ".spellcheck.yml" | ||
- ".markdownlintrc" | ||
- "mkdocs.yml" | ||
|
||
jobs: | ||
build: | ||
name: Docs check (spellcheck, markdownlint) | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
- uses: rojopolis/spellcheck-github-actions@0.8.0 | ||
name: Spellcheck | ||
- name: Run markdownlint on docs | ||
uses: docker://avtodev/markdown-lint:v1 | ||
with: | ||
config: '.markdownlintrc' | ||
args: '*.md docs' | ||
# - name: Debugging with tmate | ||
# uses: mxschmitt/action-tmate@v3.1 | ||
- name: Test mkdocs | ||
run: | | ||
sudo pip3 install setuptools | ||
sudo pip3 install mkdocs==0.17.5 | ||
mkdocs -q build -d /tmp/mkdocsbuild |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,10 +1,6 @@ | ||
# Temporary build-tools artifacts to be ignored | ||
/.go/ | ||
/.gotmp/ | ||
/bin/ | ||
/VERSION.txt | ||
/.docker_image | ||
/debug | ||
/debug.test | ||
|
||
.docker_image | ||
/dictionary.dic | ||
/.idea |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
matrix: | ||
- name: Markdown | ||
aspell: | ||
lang: en | ||
dictionary: | ||
wordlists: | ||
- .spellcheckwordlist.txt | ||
encoding: utf-8 | ||
pipeline: | ||
- pyspelling.filters.markdown: | ||
markdown_extensions: | ||
- pymdownx.superfences: | ||
- pyspelling.filters.html: | ||
comments: false | ||
ignores: | ||
- code | ||
- pre | ||
sources: | ||
- 'docs/users/*.md' | ||
- 'index.md' | ||
default_encoding: utf-8 |
Oops, something went wrong.