README.md

@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: mdx-js/mdx#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"
  }
}

Lefthook

Check staged markdown

# .lefthook.yml
pre-commit:
  parallel: true
  commands:
    doc-lint:
      glob: '*.{md,markdown,mdx}'
      run: pnpm exec remark --frail {staged_files}

Editor

For VSCode is recommended the following extensions:

• remark
• mdx

License

@tiagoporto/remark-config © 2024 by Tiago Porto is licensed under MIT License.