chore: add markdown linter (#474)

* docs: fix markdown linter errors

* chore: add markdown linter

.remarkrc

@@ -0,0 +1,5 @@
+{
+  "presets": [
+    "lint-recommended"
+  ]
+}

README.md

@@ -1,5 +1,4 @@
-![Lux](https://lux.postlight.com/assets/logo-lux.svg)
---
+# ![Lux](https://lux.postlight.com/assets/logo-lux.svg)
 
 [![CircleCI](https://circleci.com/gh/postlight/lux/tree/master.svg?style=svg)](https://circleci.com/gh/postlight/lux/tree/master) [![Build status](https://ci.appveyor.com/api/projects/status/xxwunscfe3rsxdmr/branch/master?svg=true)](https://ci.appveyor.com/project/zacharygolba/lux/branch/master) [![codecov](https://codecov.io/gh/postlight/lux/branch/master/graph/badge.svg)](https://codecov.io/gh/postlight/lux)
  [![Dependency Status](https://david-dm.org/postlight/lux.svg)](https://david-dm.org/postlight/lux) [![npm version](https://badge.fury.io/js/lux-framework.svg)](https://badge.fury.io/js/lux-framework) [![Join the chat at https://gitter.im/postlight/lux](https://badges.gitter.im/postlight/lux.svg)](https://gitter.im/postlight/lux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -18,21 +17,21 @@ This isn't another wrapper around [Express](http://expressjs.com/) or a framewor
 
 ### Features
 
-* Automatic CRUD actions in controllers
-* Automatic pagination, sorting, filtering via query params in controllers
-* CLI for eliminating boiler plate
-* [JSON API](http://jsonapi.org/) 1.0 compliant out of the box
-* Optimized database queries based on serialized attributes and associations
-* Highly extensible - just write reusable JavaScript functions
-* Pairs nicely with client-side JavaScript applications 🍷
-* Easy to contribute
-* Routes are stored and accessed via a `Map` not an `Array`
-* Embraces ES2015 and beyond
-  * Classes
-  * Modules
-  * Promises & async/await
-  * Arrow Functions
-  * etc.
+*   Automatic CRUD actions in controllers
+*   Automatic pagination, sorting, filtering via query params in controllers
+*   CLI for eliminating boiler plate
+*   [JSON API](http://jsonapi.org/) 1.0 compliant out of the box
+*   Optimized database queries based on serialized attributes and associations
+*   Highly extensible - just write reusable JavaScript functions
+*   Pairs nicely with client-side JavaScript applications 🍷
+*   Easy to contribute
+*   Routes are stored and accessed via a `Map` not an `Array`
+*   Embraces ES2015 and beyond
+    *   Classes
+    *   Modules
+    *   Promises & async/await
+    *   Arrow Functions
+    *   etc.
 
 
 ### Philosophies
@@ -143,7 +142,7 @@ For more information checkout out the [Guides](https://lux.postlight.com/).
 
 ## Benchmarks
 
-https://github.com/postlight/lux-benchmarks
+[**postlight/lux-benchmarks**](https://github.com/postlight/lux-benchmarks)
 
 
 ## Contributing
@@ -176,6 +175,6 @@ npm test
 
 ## Useful Links
 
-* [JSON API](http://jsonapi.org/)
-* [Knex.js](http://knexjs.org/)
-* [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
+*   [JSON API](http://jsonapi.org/)
+*   [Knex.js](http://knexjs.org/)
+*   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)

ROADMAP.md

@@ -141,12 +141,12 @@ The example above would create the columns `commentable_id` and `commentable_typ
 
 Below is a list of features that will likely be a part of the `1.0` release but their API is still in very early stages.
 
-- WebSockets
-  - Controller API
-  - Model Hook API
-
-- Application Testing
-  - Test Generators
-  - Debugging Tools
-  - ~~Generated SQL Logging ([#48](https://github.com/postlight/lux/issues/48))~~
-    - Implemented in #65
+*   WebSockets
+    *   Controller API
+    *   Model Hook API
+
+*   Application Testing
+    *   Test Generators
+    *   Debugging Tools
+    *   ~~Generated SQL Logging ([#48](https://github.com/postlight/lux/issues/48))~~
+        *   Implemented in #65

examples/social-network/README.md

@@ -2,21 +2,21 @@
 
 ## Installation
 
-* `git clone https://github.com/<this-repository>`
-* `cd social-network`
-* `npm install`
+*   `git clone https://github.com/<this-repository>`
+*   `cd social-network`
+*   `npm install`
 
 ## Running / Development
 
-* `lux db:reset`
-* `lux db:migrate`
-* `lux db:seed`
-* `lux serve`
+*   `lux db:reset`
+*   `lux db:migrate`
+*   `lux db:seed`
+*   `lux serve`
 
 ## Testing
 
-* `lux test`
+*   `lux test`
 
 ## Further Reading / Useful Links
-* [Lux](https://github.com/postlight/lux/)
-* [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
+*   [Lux](https://github.com/postlight/lux/)
+*   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)

examples/todo/README.md

@@ -2,21 +2,21 @@
 
 ## Installation
 
-* `git clone https://github.com/<this-repository>`
-* `cd todo`
-* `npm install`
+*   `git clone https://github.com/<this-repository>`
+*   `cd todo`
+*   `npm install`
 
 ## Running / Development
 
-* `lux db:reset`
-* `lux db:migrate`
-* `lux db:seed`
-* `lux serve`
+*   `lux db:reset`
+*   `lux db:migrate`
+*   `lux db:seed`
+*   `lux serve`
 
 ## Testing
 
-* `lux test`
+*   `lux test`
 
 ## Further Reading / Useful Links
-* [Lux](https://github.com/postlight/lux/)
-* [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
+*   [Lux](https://github.com/postlight/lux/)
+*   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)

package.json

@@ -22,7 +22,7 @@
     "build:test": "node scripts/build/test.js",
     "clean": "node scripts/clean.js",
     "flow": "flow check",
-    "lint": "eslint .",
+    "lint": "remark . && eslint .",
     "start": "lux serve",
     "test": "npm run build && nyc -i ./lib/babel-hook.js --instrument false --source-map false mocha -r ./lib/babel-hook.js test/index.js src/**/*.test.js",
     "test:codecov": "nyc report --reporter=lcov > coverage.lcov && codecov -t $LUX_CODECOV_TOKEN"
@@ -64,6 +64,9 @@
     "mocha": "3.1.2",
     "node-fetch": "1.6.3",
     "nyc": "8.3.2",
+    "remark-cli": "2.0.0",
+    "remark-lint": "5.1.0",
+    "remark-preset-lint-recommended": "1.0.0",
     "sinon": "1.17.6"
   }
 }

src/packages/cli/templates/readme.js

@@ -9,19 +9,19 @@ export default (name: string): string => template`
 
   ## Installation
 
-  * \`git clone https://github.com/<this-repository>\`
-  * \`cd ${name}\`
-  * \`npm install\`
+  *   \`git clone https://github.com/<this-repository>\`
+  *   \`cd ${name}\`
+  *   \`npm install\`
 
   ## Running / Development
 
-  * \`lux serve\`
+  *   \`lux serve\`
 
   ## Testing
 
-  * \`lux test\`
+  *   \`lux test\`
 
   ## Further Reading / Useful Links
-  * [Lux](https://github.com/postlight/lux/)
-  * [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
+  *   [Lux](https://github.com/postlight/lux/)
+  *   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
 `;

test/test-app/README.md

@@ -2,18 +2,18 @@
 
 ## Installation
 
-* `git clone https://github.com/<this-repository>`
-* `cd test-app`
-* `npm install`
+*   `git clone https://github.com/<this-repository>`
+*   `cd test-app`
+*   `npm install`
 
 ## Running / Development
 
-* `lux serve`
+*   `lux serve`
 
 ## Testing
 
-* `lux test`
+*   `lux test`
 
 ## Further Reading / Useful Links
-* [Lux](https://github.com/postlight/lux/)
-* [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)
+*   [Lux](https://github.com/postlight/lux/)
+*   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)