Latest commit 1fb1080 Jun 4, 2018
Permalink
..
Failed to load latest commit information.
index.js Refactor code-style May 19, 2018
package.json 6.0.2 Jun 4, 2018
readme.md Migrate to `remarkjs` Dec 8, 2017

readme.md

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": [
   ...
   "preset-lint-markdown-style-guide",
+  ["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": [
   ...
   "preset-lint-markdown-style-guide",
+  ["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": [
   ...
   "preset-lint-markdown-style-guide",
+  ["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": [
   ...
   "preset-lint-markdown-style-guide",
+  ["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": [
   ...
   "preset-lint-markdown-style-guide",
+  ["lint-code-block-style", "indented"]
   ...
 ]

Rules

This preset configures remark-lint with the following rules:

Rule Setting
file-extension 'md'
no-file-name-mixed-case
no-file-name-articles
no-file-name-irregular-characters
no-file-name-consecutive-dashes
no-file-name-outer-dashes
no-consecutive-blank-lines
maximum-line-length 80
no-shell-dollars
hard-break-spaces
heading-style 'atx'
heading-increment
no-duplicate-headings
no-multiple-toplevel-headings
maximum-heading-length
no-heading-punctuation ':.'
blockquote-indentation 2
no-blockquote-without-marker
unordered-list-marker-style '-'
ordered-list-marker-style '.'
ordered-list-marker-value 'one'
list-item-indent 'mixed'
list-item-content-indent
list-item-spacing
code-block-style 'fenced'
fenced-code-flag {allowEmpty: false}
fenced-code-marker '`'
rule-style '---'
no-table-indentation
table-pipes
table-pipe-alignment
table-cell-padding 'padded'
no-inline-padding
no-shortcut-reference-image
no-shortcut-reference-link
final-definition
definition-case
definition-spacing
link-title-style '"'
strong-marker '*'
emphasis-marker '*'
no-emphasis-as-heading
no-literal-urls
no-auto-link-without-protocol

Install

npm:

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

Usage

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

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

Or use it on the CLI directly

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

Or use this on the API:

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

 remark()
+  .use(require('remark-preset-lint-markdown-style-guide'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer