remark-preset-lint-markdown-style-guide
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlPreset of
remark-lintgithub-remark-lint rules that follow an opinionated style guide.Contents
unified().use(remarkPresetLintMarkdownStyleGuide)What is this?
This package is a preset containingremark-lint rules.
Lint rules check markdown code style.When should I use this?
You can use this package to check that markdown follows 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 as they relate to prose rather than markdown syntax.
You could set-up
remark-retext
with
retext-sentence-spacing
to check this.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"],
…
]Plugins
This preset includes the following plugins:| Plugin | Options | | - | - | |
remark-lint | |
| remark-lint-blockquote-indentation | 2 |
| remark-lint-code-block-style | 'fenced' |
| remark-lint-definition-case | |
| remark-lint-definition-spacing | |
| remark-lint-emphasis-marker | '*' |
| remark-lint-fenced-code-flag | { allowEmpty: false } |
| remark-lint-fenced-code-marker | `''`` |
| remark-lint-file-extension | 'md' |
| remark-lint-final-definition | |
| remark-lint-hard-break-spaces | |
| remark-lint-heading-increment | |
| remark-lint-heading-style | 'atx' |
| remark-lint-link-title-style | '"' |
| remark-lint-list-item-content-indent | |
| remark-lint-list-item-indent | 'mixed' |
| remark-lint-list-item-spacing | |
| remark-lint-maximum-heading-length | |
| remark-lint-maximum-line-length | 80 |
| remark-lint-no-blockquote-without-marker | |
| remark-lint-no-consecutive-blank-lines | |
| remark-lint-no-duplicate-headings | |
| remark-lint-no-emphasis-as-heading | |
| remark-lint-no-file-name-articles | |
| remark-lint-no-file-name-consecutive-dashes | |
| remark-lint-no-file-name-irregular-characters | |
| remark-lint-no-file-name-mixed-case | |
| remark-lint-no-file-name-outer-dashes | |
| remark-lint-no-heading-punctuation | ':.' |
| remark-lint-no-literal-urls | |
| remark-lint-no-multiple-toplevel-headings | |
| remark-lint-no-shell-dollars | |
| remark-lint-no-shortcut-reference-image | |
| remark-lint-no-shortcut-reference-link | |
| remark-lint-no-table-indentation | |
| remark-lint-ordered-list-marker-style | '.' |
| remark-lint-ordered-list-marker-value | 'one' |
| remark-lint-rule-style | '---' |
| remark-lint-strong-marker | '*' |
| remark-lint-table-cell-padding | 'padded' |
| remark-lint-table-pipe-alignment | |
| remark-lint-table-pipes | |
| remark-lint-unordered-list-marker-style | '-' |Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-preset-lint-markdown-style-guideIn Deno with
esm.shesm-sh:import remarkPresetLintMarkdownStyleGuide from 'https://esm.sh/remark-preset-lint-markdown-style-guide@6'In browsers with
esm.shesm-sh:<script type="module">
import remarkPresetLintMarkdownStyleGuide from 'https://esm.sh/remark-preset-lint-markdown-style-guide@6?bundle'
</script>Use
On the API:import remarkParse from 'remark-parse'
import remarkPresetLintMarkdownStyleGuide from 'remark-preset-lint-markdown-style-guide'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkPresetLintMarkdownStyleGuide)
.use(remarkStringify)
.process(file)
console.error(reporter(file))On the CLI:
remark --frail --use remark-preset-lint-markdown-style-guide .On the CLI in a config file (here a
package.json):…
"remarkConfig": {
"plugins": [
…
+ "remark-preset-lint-markdown-style-guide",
…
]
}
…API
This package exports no identifiers. It exports no additional TypeScripttypescript types. The default export isremarkPresetLintMarkdownStyleGuideapi-remark-preset-lint-markdown-style-guide.unified().use(remarkPresetLintMarkdownStyleGuide)
Check that markdown follows “Markdown Style Guide”.You can reconfigure rules in the preset by using them afterwards with different options.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
remark-preset-lint-markdown-style-guide@6,
compatible with Node.js 16.Contribute
Seecontributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways
to get started.
See support.mdgithub-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.
