Add markdown linting

.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, and run npm test
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Lint
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: 'npm'
+      - name: Setup Cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -1,7 +1,26 @@
 # WordPress Coding Standards Docs
 
-This repo contains the source for the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/) on https://developer.wordpress.org
+## About
 
-When creating new files, these must be added to the [manifest.json](https://github.com/WordPress/wpcs-docs/blob/master/manifest.json) file. 
+This repo contains the source for the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/) published at <https://developer.wordpress.org/coding-standards>.
+
+When creating new files, these must be added to the [manifest.json](https://github.com/WordPress/wpcs-docs/blob/master/manifest.json) file.
 
 Removing files also requires updating the [manifest.json](https://github.com/WordPress/wpcs-docs/blob/master/manifest.json) file. After deletion and sync with DevHub, the page also needs to be manually deleted from DevHub.
+
+## Linting
+
+Basic developer tooling has been added that enables Markdown linting using [markdownlint](https://github.com/DavidAnson/markdownlint) to ensure the markdown style used in this repo is compatible with the markdown parser used for publishing this repo to the developer hub.
+
+The [markdownlint-cli configuration](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-scripts/#lint-md-docs) is inherited from the [@wordpress/scripts](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-scripts/#lint-md-docs) package, this results in a straight forward zero-config setup in this repo.
+
+### Install
+
+The ease the maintenance burden of the linting setup in this repo it use's Node.js' `lts/*`, which at the time of writing was Node.js v16.x and npm v8.x, further details on the latest Node.js LTS release can be read at [https://nodejs.org/en/about/releases/](https://nodejs.org/en/about/releases/), this should result in relatively little maintenance of this setup.
+
+To install and run markdownlint:
+
+```shell
+npm install
+npm test
+```