Metadata-Version: 2.4
Name: mdrefcheck
Version: 0.1.6
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

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

## 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

### Cargo

`mdrefcheck` is also published on [crates.io](https://crates.io/) and can be installed 
with cargo:

```bash
cargo install mdrefcheck
```

### PyPI

`mdrefcheck` can be installed with

```bash
pip install mdrefcheck
```

It also can be used as a tool in an isolated environment, e.g., with `uvx`:

```bash
uvx mdrefcheck .
```

### Pre-commit integration

You can use `mdrefcheck` as a pre-commit hook.

Add this to your `.pre-commit-config.yaml`:

```yaml
repos:
  - repo: https://github.com/gospodima/mdrefcheck
    rev: v0.1.6
    hooks:
      - id: mdrefcheck
```

