Metadata-Version: 2.4
Name: mdrefcheck
Version: 0.1.5
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
License-File: LICENSE
Summary: A CLI tool to validate references in markdown files.
Home-Page: https://github.com/gospodima/mdrefcheck
Author-email: gospodima <dimasc28@gmail.com>
License-Expression: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Repository, https://github.com/gospodima/mdrefcheck

# mdrefcheck

**mdrefcheck** is a CLI tool to validate references and links in Markdown files (CommonMark spec).  
It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.

---

## Features

- Validate local file paths in image and section references
- Check section links (`#heading-link`) match existing headings according to [GitHub Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links) rules
- Identify broken reference-style links
- Email validation

---

## Installation

From PyPI:

```bash
pip install mdrefcheck
```

