@tiagoporto/remark-config v1.6.0

@tiagoporto/remark-config

Shareable Config for remark.

Installation

npm install --save-dev remark remark-cli @tiagoporto/remark-config

Usage

// .remarkrc
{
  "plugins": ["@tiagoporto/remark-config"]
}

MDX

// .remarkrc
{
  "plugins": ["@tiagoporto/remark-config/mdx"]
}

Note: Running this settings against md files can return unexpected results. Example: https://github.com/mdx-js/mdx/issues/2576.

The workaround is to create a new .remarkrc file under mdx folder.

.
├── packages
│   ├── .remarkrc (MDX Config)
│   ├── TODO.mdx
│   └── README.mdx
│
├── .remarkrc
└── README.md

In package.json add the following scripts:

{
  "scripts": {
    "check-docs": "remark --frail . --ext md,markdown,mdx"
  }
}

Lint-staged

Check staged markdown

// .lintstagedrc.mjs
export default {
  '*.{md,markdown,mdx}': 'remark --frail',
}

Editor

For VSCode is recommended the following extensions:

• remark