add remark to lint markdown and a circle ci config

Author: clarkbw

.gitignore

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

.remarkrc

@@ -0,0 +1,7 @@
+{
+  "plugins": [
+      "remark-preset-lint-recommended",
+      ["remark-lint-list-item-indent", "space"],
+      "validate-links"
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+:tada: Thanks for contributing to this docs project! :tada:
+
+This document needs lots of help, please update and improve it!
+
+### Setup
+
+To get started you'll need to install the dependencies required using [yarn](https://yarnpkg.com/).
+
+```bash
+yarn install
+```
+
+### Test
+
+We use `remark` to validate the markdown files for consistency and bad links.
+
+```bash
+yarn test
+```

README.md

@@ -20,7 +20,7 @@ The repositories in `devtools-html` are more straightforward if you're used to *
 
 Since we have code in two different places, issues and bugs are to be found in two different places:
 
-* For code in `m-c`: http://firefox-dev.tools/ which also lets you filter by good bugs for beginners.
+* For code in `m-c`: [http://firefox-dev.tools/](http://firefox-dev.tools/) which also lets you filter by good bugs for beginners.
 * For code in `devtools-html`: [this page](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen&type=Issues) lists all the issues across the organisation.
 <!--TODO: ^^ add label:"help wanted" or similar to the query to get easy issues-->
 
@@ -47,7 +47,7 @@ This is just a brief overview. For more detailed documentation:
 
 The tools are broadly divided into panels. Each panel has one or more owners, who mostly work(s) on that panel and are the best people to ask if you have specific questions about the code.
 
-<!-- TODO: from https://wiki.mozilla.org/DevTools/GetInvolved#Communication but update it --> 
+<!-- TODO: from https://wiki.mozilla.org/DevTools/GetInvolved#Communication but update it -->
 <!-- TODO: * show organisations in github (doesn't work if people don't make their membership public) -->
 
 ## News and demos

circle.yml

@@ -0,0 +1,13 @@
+machine:
+  environment:
+    PATH: "${PATH}:${HOME}/${CIRCLE_PROJECT_REPONAME}/node_modules/.bin"
+
+dependencies:
+  override:
+    - yarn
+  cache_directories:
+    - ~/.cache/yarn
+
+test:
+  override:
+    - yarn test

package.json

@@ -0,0 +1,18 @@
+{
+  "name": "devtools-html.github.com",
+  "version": "1.0.0",
+  "description": "https://devtools-html.github.io/",
+  "repository": "[email protected]:devtools-html/devtools-html.github.com.git",
+  "author": "DevTools.html",
+  "license": "CC0-1.0",
+  "scripts": {
+    "lint": "remark .",
+    "test": "yarn run lint"
+  },
+  "devDependencies": {
+    "remark-cli": "^3.0.0",
+    "remark-lint": "^6.0.0",
+    "remark-preset-lint-recommended": "^2.0.0",
+    "remark-validate-links": "^6.0.0"
+  }
+}