remark-preset-lint-markdown-style-guide

remark-preset-lint-markdown-style-guide

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

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

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

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

This package exports no identifiers. The default export is remarkPresetLintMarkdownStyleGuide.

Use

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkPresetLintMarkdownStyleGuide from 'remark-preset-lint-markdown-style-guide'

 remark()
+  .use(remarkPresetLintMarkdownStyleGuide)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer