@newlevelup/remark-config

remark-config

New Level Up shareable config for remark

Installation

💡 The purpose of the remark is to format your markdown files.

Install remark and @newlevelup/remark-config:

yarn add -D remark remark-cli @newlevelup/remark-config

Usage

💡 Note: You can make use of the unifiedjs.vscode-remark extension to integrate remark with vscode environment and automate the lint process.

New Level Up remark rules come bundled in @newlevelup/remark-config. To enable these rules, add a remarkConfig property in your package.json. See the remark configuration docs for more details.

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

If you don't want to use package.json, you can use any of the supported extensions to export a string:

// .remarkrc.mjs
export { default } from '@newlevelup/remark-config';

Ignore

If you need to ignore certain paths,

# .remarkignore
node_modules/

# ignore autogenerated files
CHANGELOG.md