README.md

# MDExCustomHeadingId

[![Hex.pm][shield-hex]][hexpm] [![Hex Docs][shield-docs]][docs]
[![Apache 2.0][shield-licence]][licence] ![Coveralls][shield-coveralls]

- code :: <https://github.com/halostatue/mdex_custom_heading_id>
- issues :: <https://github.com/halostatue/mdex_custom_heading_id/issues>

An MDEx plugin that supports custom header IDs

## Installation

Add `mdex_custom_heading_id` to your dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:mdex_custom_heading_id, "~> 1.0"}
  ]
end
```

Documentation is found on [HexDocs][docs].

## Semantic Versioning

MDExCustomHeadingId follows [Semantic Versioning 2.0][semver].

[docs]: https://hexdocs.pm/mdex_custom_heading_id
[hexpm]: https://hex.pm/packages/mdex_custom_heading_id
[licence]: https://github.com/halostatue/mdex_custom_heading_id/blob/main/LICENCE.md
[semver]: https://semver.org/
[shield-coveralls]: https://img.shields.io/coverallsCoverage/github/halostatue/mdex_custom_heading_id?style=for-the-badge
[shield-docs]: https://img.shields.io/badge/hex-docs-purple.svg?style=for-the-badge
[shield-hex]: https://img.shields.io/hexpm/v/mdex_custom_heading_id.svg?style=for-the-badge
[shield-licence]: https://img.shields.io/hexpm/l/mdex_custom_heading_id.svg?style=for-the-badge