Fixes the Markdown lint config and affected files (#676)

I also ran our documentation against a few other linters, to see what
they would find, and fixed accordingly.

.github/workflows/mdlint.yml

@@ -17,5 +17,5 @@ jobs:
         uses: nosborn/github-action-markdown-cli@v3
         with:
           files: '**/*.md'
-          ignore_files: "third_party/*"
+          config_file: '.markdownlint.json'
-          config_file: ".markdownlint.json"
+          ignore_files: 'third_party/*'

.markdownlint.json

@@ -1,35 +1,22 @@
 {
     "default": true,
-    "heading-style": {
+    "MD003": {
         "style": "atx"
     },
-    "no-trailing-spaces": {
+    "MD007": {
+        "indent": 4
+    },
+    "MD009": {
         "br_spaces": 0,
         "strict": true
     },
-    "ul-indent": {
+    "MD013": {
-        "indent": 4
-    },
-    "line-length": {
         "line_length": 80,
         "code_blocks": false
     },
-    "list-marker-space": {
+    "MD033": {
-        "ol_single": 2,
-        "ol_multi": 2,
-        "ul_single": 3,
-        "ul_multi": 3
-    },
-    "no-inline-html": {
         "allowed_elements": [
         "img"
 	]
-    },
-    "fenced-code-language": true,
-    "code-block-style": {
-        "style": "fenced"
-    },
-    "code-fence-style": {
-        "style": "backtick"
     }
 }

docs/customization.md

@@ -7,18 +7,18 @@
 All the generated certificates and private keys are stored in the directory
 `crypto_data/`. The expected content after running our `setup.sh` script is:
 
-File                     | Purpose
+| File                     | Purpose                                         |
------------------------- | --------------------------------------------------------
+| ------------------------ | ----------------------------------------------- |
-`aaguid.txt`             | Text file containaing the AAGUID value
+| `aaguid.txt`             | Text file containaing the AAGUID value          |
-`opensk_ca.csr`          | Certificate sign request for the Root CA
+| `opensk_ca.csr`          | Certificate sign request for the Root CA        |
-`opensk_ca.key`          | ECC secp256r1 private key used for the Root CA
+| `opensk_ca.key`          | ECC secp256r1 private key used for the Root CA  |
-`opensk_ca.pem`          | PEM encoded certificate of the Root CA
+| `opensk_ca.pem`          | PEM encoded certificate of the Root CA          |
-`opensk_ca.srl`          | File generated by OpenSSL
+| `opensk_ca.srl`          | File generated by OpenSSL                       |
-`opensk_cert.csr`        | Certificate sign request for the attestation certificate
+| `opensk_cert.csr`        | CSR for attestation certificate                 |
-`opensk_cert.pem`        | PEM encoded certificate used for the authenticator
+| `opensk_cert.pem`        | PEM encoded certificate for the authenticator   |
-`opensk.key`             | ECC secp256r1 private key used for the autenticator
+| `opensk.key`             | ECC secp256r1 private key for the autenticator  |
-`opensk_upgrade.key`     | Private key for signing upgrades through CTAP
+| `opensk_upgrade.key`     | Private key for signing upgrades through CTAP   |
-`opensk_upgrade_pub.pem` | Public key added to the firmware for verifying upgrades
+| `opensk_upgrade_pub.pem` | Public key for verifying upgrades               |
 
 If you want to use your own attestation certificate and private key,
 replace the `opensk_cert.pem` and `opensk.key` files. The script at

docs/install.md

@@ -62,23 +62,23 @@ following steps:
   ./setup.sh
   ```
 
-*   Flash your board according to the
+* Flash your board according to the [instructions below](#flashing-a-firmware).
-    [flashing instructions below](#Flashing-a-firmware]. If you come from an
-    OpenSK version before the 2.0 certified one, your credential storage is not
-    backwards compatible and you have to reset it. :warning: You will lose
-    logins to all websites that you registered with OpenSK. To erase your
-    persistent storage, run the deploy script twice: Once with the application
-    parameter `--erase_storage`, and once with `--opensk` as usual.
 
-    This reset also clears the certificate. For a privacy discussion, see the
+If you come from an OpenSK version before the 2.0 certified one, your credential
-    [certificate section in Customization](customization.md#Certificate-considerations).
+storage is not backwards compatible and you have to reset it. :warning: You will
-    If you want to reinstall it, you also need to rerun:
+lose logins to all websites that you registered with OpenSK. To erase your
+persistent storage, run the deploy script twice: Once with the application
+parameter `--erase_storage`, and once with `--opensk` as usual.
 
-    ```shell
+This reset also clears the certificate. For a privacy discussion, see the
-    ./tools/configure.py \
+[certificate section in Customization](customization.md#Certificate-considerations).
+If you want to reinstall it, you also need to rerun:
+
+```shell
+./tools/configure.py \
     --certificate=crypto_data/opensk_cert.pem \
     --private-key=crypto_data/opensk.key
-    ```
+```
 
 #### Initial setup