@dnb-org/remark-config v3.5.11

@dnb-org/remark-config

Remark configuration used in dnb-org projects.

Installation

Use npm to install this package as development dependency:

npm install --save-dev @dnb-org/remark-config

Configuration

Put the following into .remarkrc in the root of your project. Remove the write-good line if you want to ensure the quality of text. It tends to be overzealous though, so it's deactivated by default.

{
  "plugins": ["@dnb-org/remark-config", ["remark-lint-write-good", false]]
}

or in .remarkrc.js:

const defaultRemarkConfig = require("@dnb-org/remark-config");
module.exports = defaultRemarkConfig;

or in remarkConfig in package.json:

{
  "remarkConfig": {
    "plugins": ["@dnb-org/remark-config"]
  }
}

Configuration rules in this package

The dnb-org ruleset for remark-lint uses the following two presets:

• remark-preset-lint-styleguide - a preset to maintain good quality readable markdown files.
• remark-preset-lint-consistent - a preset that enforces consistency and helps avoiding common known pitfalls in markdown parsers (consistency rules may override the styleguide rules).

The following rules and plugins are added or changed:

• remark-lint-first-heading-level - sets the first heading level to h2, so that h1 can be used as page title after parsing
• remark-frontmatter - support frontmatter in markdown files
• remark-lint-linebreak-style - sets the linebreak style to unix \n line endings
• remark-lint-write-good - checks style of the writing via write-good and can be disabled (see configuration above)
• remark-lint-match-punctuation to ensure programming punctuation comes in pairs.
• remark-lint-no-repeat-punctuation to ensure punktuation not doubled
• remark-lint-emoji-limit - to make sure documents are not too emoji-y
• remark-lint-no-empty-sections - to ensure no empty sections are in the documents
• remark-lint-heading-whitespace - makes sure that no exotic whitespaces break parsing of headings

DNB-Org/Configurations

A collection of configurations for website development at DNB Org.