Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1

.github/workflows/docs.yaml

@@ -5,14 +5,18 @@ on:
     branches: [ develop, release ]
     paths:
     - 'docs/**'
+    - 'docs_theme/**'
     - 'mkdocs.yml'
     - 'readthedocs.yml'
+    - '.github/workflows/docs.yaml'
   pull_request_target:
     branches: [ develop ]
     paths:
     - 'docs/**'
+    - 'docs_theme/**'
     - 'mkdocs.yml'
     - 'readthedocs.yml'
+    - '.github/workflows/docs.yaml'
 
 jobs:
   accessibility:
@@ -47,14 +51,31 @@ jobs:
       run: poetry run mkdocs serve &
 
     - name: Accessibility testing (Pa11y)
-      run: poetry run .github/workflows/pa11y.sh
+      env:
+        site_url: http://127.0.0.1:8000
+        exit_code: 0
+      run: |
+        set +e
+
+        poetry run mkdocs build
+        mkdir -p "reports"
+
+        printf -- 'scanning: /\n'
+        ./node_modules/.bin/pa11y "$site_url" --reporter junit > "reports/root.xml" || exit_code=2
+
+        for file in $(poetry run xq '.urlset.url[].loc' site/sitemap.xml -r | sed -r 's!https://jrnl.sh/(.*?)/$!\1!'); do
+          printf -- 'scanning: /%s\n' "$file"
+          ./node_modules/.bin/pa11y "$site_url/$file" --reporter junit > "reports/$file.xml" || exit_code=2
+        done
+
+        exit $exit_code
 
     - name: Upload Unit Test Results
       if: always()
       uses: actions/upload-artifact@v2
       with:
         name: Unit Test Results (pa11y)
-        path: reports/pa11y/*.xml
+        path: reports/*.xml
 
   publish-test-results:
     if: success() || failure()
@@ -70,7 +91,7 @@ jobs:
 
       - name: Publish Unit Test Results
         uses: EnricoMi/[email protected]
-        if: always()
+        if: success() || failure()
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           check_name: Unit Test Results

docs/formats.md

@@ -51,7 +51,8 @@ This format is configurable through these values from your config file (see
 | This is the sample body text of the first sample entry.
 
 2020-07-01 20:00 This is the second sample entry
-| This is the sample body text of the second sample entry, but this one has a @tag.
+| This is the sample body text of the second sample entry, but
+| this one has a @tag.
 
 2020-07-02 09:00 This is the third sample entry
 | This is the sample body text of the third sample entry.
@@ -119,7 +120,7 @@ jrnl --format json
 
 JSON is a very handy format used by many programs and has support in nearly every
 programming language. There are many things you could do with JSON data. Maybe you could
-use [`jq`](https://github.com/stedolan/jq) to filter through the fields in your journal.
+use `jq` ([project page](https://github.com/stedolan/jq)) to filter through the fields in your journal.
 Like this:
 
 ``` sh

docs/installation.md

@@ -22,8 +22,8 @@ should be created and whether you wish to encrypt it.
 
 To make a new entry, just type
 
-``` sh
-jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.
+``` text
+jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
 ```
 
 and hit return. `yesterday:` will be interpreted as a time stamp.