starlight-links-validator/README.md

Starlight plugin to validate internal links.

<div align="center">
  <h1>starlight-links-validator 🦺</h1>
  <p>Starlight plugin to validate internal links.</p>
  <p>
    <a href="https://github.com/HiDeoo/starlight-links-validator/assets/494699/fe5f797a-8089-4271-b090-7158bb053dfa" title="Screenshot of starlight-links-validator">
      <img alt="Screenshot of starlight-links-validator" src="https://github.com/HiDeoo/starlight-links-validator/assets/494699/fe5f797a-8089-4271-b090-7158bb053dfa" width="520" />
    </a>
  </p>
</div>

<div align="center">
  <a href="https://github.com/HiDeoo/starlight-links-validator/actions/workflows/integration.yml">
    <img alt="Integration Status" src="https://github.com/HiDeoo/starlight-links-validator/actions/workflows/integration.yml/badge.svg" />
  </a>
  <a href="https://github.com/HiDeoo/starlight-links-validator/blob/main/LICENSE">
    <img alt="License" src="https://badgen.net/github/license/HiDeoo/starlight-links-validator" />
  </a>
  <br />
</div>

## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-links-validator.vercel.app/getting-started/).

## Features

A [Starlight](https://starlight.astro.build) plugin to validate **_internal_** links in Markdown and MDX files.

- Validate internal links to other pages
- Validate internal links to hashes in other pages
- Validate internal links to hashes in the same page
- Ignore external links
- Run only during a production build

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-links-validator/blob/main/LICENSE) for more information.