Add helper script for Markdown listing.

Author: johnboxall

CHANGELOG

@@ -1,3 +1,5 @@
+2.4.4
+    - Adds markdown linting
 2.4.3
     - Add eslint rule + doc entry regarding trailing commas
 2.4.2

README.md

@@ -36,3 +36,7 @@ Our Client Services team's [CSS Style Guide](/css/Readme.md). Written with a lot
 
 See the `python` directory of this repo for a standardized `pylintrc` file and
 instructions on using `pep8`, `pylint` and `pyflakes` to check Python code.
+
+## Documentation
+
+See the [`docs`](docs) directory for setup and configuration of Markdown linting.

bin/lint-md

@@ -0,0 +1,10 @@
+#!/bin/bash -eu
+# Lint markdown files using Mobify's .remarkrc configuration.
+
+# FIXME: Brittle :|
+BIN_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+CODE_STYLE_DIR="$BIN_DIR/../mobify-code-style"
+REMARK_RC="$CODE_STYLE_DIR/.remarkrc"
+REMARK_CLI="$CODE_STYLE_DIR/node_modules/.bin/remark"
+
+$REMARK_CLI --rc-path $REMARK_RC "$@"

docs/README.md

@@ -1,3 +1,32 @@
+> Write great documentation! – * [_Mobify Developer Values_](https://github.com/mobify/developer-values#️-write-great-documentation)
+
+At Mobify, documentation is written in markdown.
+
+Documentation should live as close as possible to the code it documents.
+Typically, this means including it in a `docs` folder at the root of the repo.
+Customer facing documentation should be published to a sub path of
+docs.mobify.com.
+
+To make writing document easier, we provide:
+
+* A linter for consistent markdown style.
+* A writing checklist for consistent process.
+
+### Markdown Linting
+
+```bash
+npm install --save mobify-code-style
+
+# 🏃 the linter markdown files in the `docs` folder:
+./node_modules/.bin/lint-md docs
+
+# Arguments are passed to `remark-cli`: https://github.com/wooorm/remark/tree/master/packages/remark-cli
+./node_modules/.bin/lint-md --watch docs
+
+# Try to automajically fix linting warnings:
+./node_modules/.bin/lint-md --output docs
+```
+
 ### Writing Checklist
 
 **Before you start writing**

package.json

@@ -11,6 +11,9 @@
   "bugs": {
     "url": "https://github.com/mobify/mobify-code-style/issues"
   },
+  "bin": {
+    "lint-md": "./bin/lint-md"
+  },
   "homepage": "https://github.com/mobify/mobify-code-style",
   "scripts": {
     "test": "bash docs/test/test.sh"
@@ -20,4 +23,4 @@
     "remark-lint": "5.0.1",
     "remark-preset-lint-recommended": "1.0.0"
   }
-}
+}