开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

remark plugins to check (lint) markdown code style.

Contents

• What is this?
• When should I use this?
• Presets
• Rules
• Configure
• Ignore warnings
• Examples
  • Example: check markdown on the API
  • Example: check and format markdown on the API
  • Example: check markdown on the CLI
  • Example: check and format markdown on the CLI
• Integrations
• Syntax
• Compatibility
• Security
• Contribute
• License

What is this?

You can use this to check markdown. Say we have a markdown file doc/example.md that contains:

1) Hello, _Jupiter_ and *Neptune*!

Then assuming we installed dependencies and run:

npx remark doc/ --use remark-preset-lint-consistent --use remark-preset-lint-recommended

We would get a report like this:

doc/example.md
   1:1-1:35  warning  Marker style should be `.`               ordered-list-marker-style  remark-lint
        1:4  warning  Incorrect list-item indent: add 1 space  list-item-indent           remark-lint
  1:25-1:34  warning  Emphasis should use `_` as a marker      emphasis-marker            remark-lint

⚠ 3 warnings

This GitHub repository is a monorepo that contains ±70 plugins (each a rule that checks one specific thing) and 3 presets (combinations of rules configured to check for certain styles).

These packages are build on unified (remark). unified is a project that inspects and transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. These lint rules inspect mdast.

When should I use this?

This project is useful when developers or technical writers are authoring documentation in markdown and you want to ensure that the markdown is consistent, free of bugs, and works well across different markdown parsers.

These packages are quite good at checking markdown. They especially shine when combined with other remark plugins and at letting you make your own rules.

Presets

Presets are combinations of rules configured to check for certain styles. The following presets only contain lint rules but you can make your own that include any remark plugins or other presets. The presets that are maintained here:

• remark-preset-lint-consistent — rules that enforce consistency
• remark-preset-lint-markdown-style-guide — rules that enforce the markdown style guide
• remark-preset-lint-recommended — rules that prevent mistakes or stuff that fails across vendors.

Rules

The rules that are maintained here:

• remark-lint-blockquote-indentation — warn when block quotes are either indented too much or too little
• remark-lint-checkbox-character-style — warn when list item checkboxes violate a given style
• remark-lint-checkbox-content-indent — warn when list item checkboxes are followed by too much whitespace
• remark-lint-code-block-style — warn when code blocks do not adhere to a given style
• remark-lint-definition-case — warn when definition labels are not lowercase
• remark-lint-definition-spacing — warn when consecutive whitespace is used in a definition
• remark-lint-emphasis-marker — warn when emphasis markers violate the given style
• remark-lint-fenced-code-flag — warn when fenced code blocks occur without language flag
• remark-lint-fenced-code-marker — warn when fenced code markers violate the given style
• remark-lint-file-extension — warn when the file’s extension violates the given style
• remark-lint-final-definition — warn when definitions are not placed at the end of the file
• remark-lint-final-newline — warn when a newline at the end of a file is missing
• remark-lint-first-heading-level — warn when the first heading has a level other than a specified value
• remark-lint-hard-break-spaces — warn when too many spaces are used to create a hard break
• remark-lint-heading-increment — warn when headings increment with more than 1 level at a time
• remark-lint-heading-style — warn when heading style violates the given style
• remark-lint-linebreak-style — warn when linebreaks violate a given or detected style
• remark-lint-link-title-style — warn when link and definition titles occur with incorrect quotes
• remark-lint-list-item-bullet-indent — warn when list item bullets are indented
• remark-lint-list-item-content-indent — warn when the content of a list item has mixed indentation
• remark-lint-list-item-indent — warn when the spacing between a list item’s bullet and its content violates a given style
• remark-lint-list-item-spacing — warn when list looseness is incorrect
• remark-lint-maximum-heading-length — warn when headings are too long
• remark-lint-maximum-line-length — warn when lines are too long
• remark-lint-no-blockquote-without-marker — warn when blank lines without markers (`>`) are found in a block quote
• remark-lint-no-consecutive-blank-lines — warn for too many consecutive blank lines
• remark-lint-no-duplicate-defined-urls — warn on definitions that define the same urls
• remark-lint-no-duplicate-definitions — warn on duplicate definitions
• remark-lint-no-duplicate-headings — warn on duplicate headings
• remark-lint-no-duplicate-headings-in-section — warn on duplicate headings in a section
• remark-lint-no-emphasis-as-heading — warn when emphasis or importance is used instead of a heading
• remark-lint-no-empty-url — warn on empty URLs in links and images
• remark-lint-no-file-name-articles — warn when file name start with an article
• remark-lint-no-file-name-consecutive-dashes — warn when file names contain consecutive dashes
• remark-lint-no-file-name-irregular-characters — warn when file names contain irregular characters
• remark-lint-no-file-name-mixed-case — warn when file names use mixed case
• remark-lint-no-file-name-outer-dashes — warn when file names contain initial or final dashes
• remark-lint-no-heading-content-indent — warn when heading content is indented
• remark-lint-no-heading-indent — warn when headings are indented
• remark-lint-no-heading-like-paragraph — for too many hashes (h7+ “headings”)
• remark-lint-no-heading-punctuation — warn when headings end in illegal characters
• remark-lint-no-html — warn when HTML nodes are used
• remark-lint-no-inline-padding — warn when inline nodes are padded with spaces
• remark-lint-no-literal-urls — warn when URLs without angle brackets are used
• remark-lint-no-missing-blank-lines — warn when missing blank lines
• remark-lint-no-multiple-toplevel-headings — warn when multiple top level headings are used
• remark-lint-no-paragraph-content-indent — warn when the content in paragraphs are indented
• remark-lint-no-reference-like-url — warn when URLs are also defined identifiers
• remark-lint-no-shell-dollars — warn when shell code is prefixed by dollars
• remark-lint-no-shortcut-reference-image — warn when shortcut reference images are used
• remark-lint-no-shortcut-reference-link — warn when shortcut reference links are used
• remark-lint-no-table-indentation — warn when tables are indented
• remark-lint-no-tabs — warn when hard tabs are used instead of spaces
• remark-lint-no-undefined-references — warn when references to undefined definitions are found
• remark-lint-no-unneeded-full-reference-image — warn when full reference images are used if they can be collapsed
• remark-lint-no-unneeded-full-reference-link — warn when full reference links are used if they can be collapsed
• remark-lint-no-unused-definitions — warn when unused definitions are found
• remark-lint-ordered-list-marker-style — warn when the markers of ordered lists violate a given style
• remark-lint-ordered-list-marker-value — warn when the marker value of ordered lists violates a given style
• remark-lint-rule-style — warn when horizontal rules violate a given style
• remark-lint-strikethrough-marker — warn when strikethrough markers violate the given style
• remark-lint-strong-marker — warn when importance (strong) markers violate the given style
• remark-lint-table-cell-padding — warn when table cells are incorrectly padded
• remark-lint-table-pipe-alignment — warn when table pipes are not aligned
• remark-lint-table-pipes — warn when table rows are not fenced with pipes
• remark-lint-unordered-list-marker-style — warn when markers of unordered lists violate a given style

You can make and share your own rules, which can be used just like the rules maintained here. The following rules are maintained by the community:

• remark-lint-alphabetize-lists — ensure list items are in alphabetical order
• remark-lint-appropriate-heading — check that the top level heading matches the directory name
• remark-lint-blank-lines-1-0-2 — ensure a specific number of lines between blocks
• remark-lint-books-links — ensure links in lists of books follow a standard format
• remark-lint-code — lint fenced code blocks by corresponding language tags, currently supporting ESLint
• remark-lint-match-punctuation — ensures punctuations are used in pairs if necessary.
• remark-lint-mdash-style — ensure em-dash (—) style follows a standard format
• remark-lint-no-chinese-punctuation-in-number — ensures that Chinese punctuation’s not used in numbers
• remark-lint-no-dead-urls — check that external links are alive
• remark-lint-no-long-code — ensures that each line in code block won't be too long.
• remark-lint-no-repeat-punctuation — ensures punctuation is not repeated
• remark-lint-emoji-limit — enforce a limit of emoji per paragraph
• remark-lint-no-empty-sections — ensure every heading is followed by content (forming a section)
• remark-lint-frontmatter-schema — validate YAML frontmatter against a JSON schema
• remark-lint-heading-length — ensure headings have the appropriate length
• remark-lint-heading-whitespace — ensure heading parsing is not broken by weird whitespace
• remark-lint-are-links-valid — check if your links are reachable and/or unique
• remark-lint-spaces-around-number — ensures there are spaces around number and Chinese.
• remark-lint-spaces-around-word — ensures there are spaces around English word and Chinese.
• remark-lint-no-url-trailing-slash — ensure that the href of links has no trailing slash
• remark-lint-write-good — wrapper for write-good
• remark-lint-double-link — ensure the same URL is not linked multiple times.

For help creating your own rule, it’s suggested to look at existing rules and to follow this tutorial.

Configure

All rules can be configured in one standard way:

import {remark} from 'remark'
import remarkLintFinalNewline from 'remark-lint-final-newline'
import remarkLintMaximumLineLength from 'remark-lint-maximum-line-length'
import remarkLintUnorderedListMarkerStyle from 'remark-lint-unordered-list-marker-style'

remark()
  // Pass `false` to turn a rule off — the code no longer runs:
  .use(remarkLintFinalNewline, false)
  // Pass `true` to turn a rule on again:
  .use(remarkLintFinalNewline, true)
  // You can also configure whether messages by the rule should be ignored,
  // are seen as code style warnings (default), or are seen as exceptions.
  // Ignore messages with `'off'` or `0` as the first value of an array:
  .use(remarkLintFinalNewline, ['off'])
  .use(remarkLintFinalNewline, [0])
  // Use `'warn'`, `'on'`, or `1` to treat messages as code style warnings:
  .use(remarkLintFinalNewline, ['warn'])
  .use(remarkLintFinalNewline, ['on'])
  .use(remarkLintFinalNewline, [1])
  // Use `'error'` or `2` to treat messages as exceptions:
  .use(remarkLintFinalNewline, ['error'])
  .use(remarkLintFinalNewline, [2])
  // Some rules accept options, and what they exactly accept is different for
  // each rule (sometimes a string, a number, or an object).
  // The following rule accepts a string:
  .use(remarkLintUnorderedListMarkerStyle, '*')
  .use(remarkLintUnorderedListMarkerStyle, ['on', '*'])
  .use(remarkLintUnorderedListMarkerStyle, [1, '*'])
  // The following rule accepts a number:
  .use(remarkLintMaximumLineLength, 72)
  .use(remarkLintMaximumLineLength, ['on', 72])
  .use(remarkLintMaximumLineLength, [1, 72])

See use() in unifieds readme for more info on how to use plugins.