Skip to content

Commit

Permalink
Spellcheck docs, fixes #2365 (#2735)
Browse files Browse the repository at this point in the history
  • Loading branch information
rfay committed Jan 8, 2021
1 parent 0c2af6b commit a66f4e6
Show file tree
Hide file tree
Showing 23 changed files with 602 additions and 226 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docscheck.yml
@@ -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
58 changes: 0 additions & 58 deletions .github/workflows/macos_github_vm_setup.sh

This file was deleted.

59 changes: 0 additions & 59 deletions .github/workflows/multiplesites.sh

This file was deleted.

37 changes: 0 additions & 37 deletions .github/workflows/nginx-tmpl.yml

This file was deleted.

4 changes: 0 additions & 4 deletions .github/workflows/testsite/index.php

This file was deleted.

8 changes: 2 additions & 6 deletions .gitignore
@@ -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
21 changes: 21 additions & 0 deletions .spellcheck.yml
@@ -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

0 comments on commit a66f4e6

Please sign in to comment.