remark-validate-links-heading-id/README.md

The plugin for remark-validate-links to support custom heading ID

# remark-validate-links-heading-id

[![npm](https://img.shields.io/npm/v/remark-validate-links-heading-id?color=blue)](https://www.npmjs.com/package/remark-validate-links-heading-id)

The plugin for [remark-validate-links](https://github.com/remarkjs/remark-validate-links) to support custom heading ID (e.g. `# Heading {#custom-heading-id}`).

## Installation

```shell
# This step is optional if you have added
yarn add remark-validate-links

yarn add remark-validate-links-heading-id
```

## Usage

Edit `package.json`:

```json
{
  ...
  "remarkConfig": {
    "plugins": [
      "remark-validate-links-heading-id",
      "remark-validate-links"
    ]
  }
}
```