remark-preset-lint-gatsby

Remark preset with settings for linting markdown Gatsby docs.

Install

npm i remark-preset-lint-gatsby
# or
yarn add remark-preset-lint-gatsby

Add preset to remark configuration as plugin:

{
  "plugins": [
    "remark-preset-lint-gatsby"
  ]
}

Rules

Includes remark-preset-lint-markdown-style-guide with few overrides and addtional rules below:

| Rule | Setting | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | checkbox-character-style | {checked: "x", unchecked: " "} | | checkbox-content-indent | | | emphasis-marker | '_' | | fenced-code-flag | languages list based on Gtasby Styleguide | | final-newline | | | first-heading-level | 2 | | item-content-indent | false | | list-item-spacing | false | | maximum-line-length | false | | no-duplicate-headings | false | | no-duplicate-headings-in-section | | | no-emphasis-as-heading | false | | no-heading-indent | | | no-heading-punctuation | '.' | | no-tabs | | | no-trailing-spaces | | | ordered-list-marker-value | false | | prohibited-strings | word list | | unordered-list-marker-style | '-' |