remark-preset-lint-markdown-style-guide

remark preset to configure remark-lint with settings that the Markdown Style Guide.

This uses the following Style Guide option system: wrap:space, header:atx, list-marker:hyphen, list-space:mixed, and code:fenced.

space-sentence

Both space-sentence:1 and space-sentence:2 are not supported by remark-lint. You could set-up remark-retext with retext-sentence-spacing to check this though.

wrap

wrap:inner-sentence and wrap:sentence are not supported by remark-lint.

The default is wrap:space. To use wrap:no, turn off remark-lint-maximum-line-length like so:

 "plugins": [
   ...
   "remark-preset-lint-markdown-style-guide",
+  ["remark-lint-maximum-line-length", false]
   ...
 ]

header

The default is header:atx. To use header:setext, change the setting for remark-lint-heading-style like so:

 "plugins": [
   ...
   "remark-preset-lint-markdown-style-guide",
+  ["remark-lint-heading-style", "setext"]
   ...
 ]

list-marker

The default is list-marker:hyphen. For list-marker:asterisk or list-marker:plus, change the setting for remark-lint-unordered-list-marker-style like so:

 "plugins": [
   ...
   "remark-preset-lint-markdown-style-guide",
+  ["remark-lint-unordered-list-marker-style", "*"]
   ...
 ]

list-space

The default is list-space:mixed. For list-space:1, change the setting for remark-lint-list-item-indent like so:

 "plugins": [
   ...
   "remark-preset-lint-markdown-style-guide",
+  ["remark-lint-list-item-indent", "space"]
   ...
 ]

code

The default is code:fenced. For code:indented, change the setting for remark-lint-code-block-style like so:

 "plugins": [
   ...
   "remark-preset-lint-markdown-style-guide",
+  ["remark-lint-code-block-style", "indented"]
   ...
 ]

Install

npm:

npm install remark-preset-lint-markdown-style-guide

You probably want to use it on the CLI through a config file:

 ...
 "remarkConfig": {
+  "plugins": ["remark-preset-lint-markdown-style-guide"]
 }
 ...

Or use it on the CLI directly

remark -u remark-preset-lint-markdown-style-guide readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 var file = remark()
+  .use(require('remark-preset-lint-markdown-style-guide'))
   .processSync('_Emphasis_ and **importance**')

 console.error(report(file));

Rules

This preset configures remark-lint with the following rules: