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 file references
- Check section links against actual headings, following GitHub Flavored Markdown (GFM) rules, including cross-file references (e.g.
./subfolder/another-file.md#heading-link) - Detect broken reference-style links
- Basic email validation
- Ignore files support via ignore crate.
Installation
Cargo
cargo install mdrefcheck
PyPI
pip install mdrefcheck
or run it directly in an isolated environment, e.g., with uvx:
uvx mdrefcheck .
Pre-commit integration
Add this to your .pre-commit-config.yaml:
repos:
- repo: https://github.com/gospodima/mdrefcheck
rev: v0.2.2
hooks:
- id: mdrefcheck
Metadata
Release files for mdrefcheck 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mdrefcheck-0.2.2.tar.gz | 19.9 kB | Without provenance | Details |
Built distributions (wheels)
Total release size: 22.7 MB
Release files / mdrefcheck-0.2.2.tar.gz
| Download URL | mdrefcheck-0.2.2.tar.gz |
|---|---|
| Size | 19.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
70bb8c74ec8ce8a5b342631f848922d303a4464bb4adcf9e43e14af80aed5ba6
|
|
BLAKE2b-256 checksum How to use checksums |
a6b75d4b5892a385d08b126fa0086c4e04cc019a8ee8a8198585e3a57bda7e79
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-win_amd64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-win_amd64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9d7add0e8106e5f1a7ff0fbf69dd77647162c9995f40bb4f803593ba7e8add39
|
|
BLAKE2b-256 checksum How to use checksums |
b35fac245fd6c5a1d19d21334d6681c465db2ea041f392712894f7213beb7751
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-win32.whl
| Download URL | mdrefcheck-0.2.2-py3-none-win32.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
00b5c29eacf1199f4c5a0f50097e62821cb71d4bd8c4a7ce78bd126f9e350b53
|
|
BLAKE2b-256 checksum How to use checksums |
c0f2a2c39959435352a6d844f6c52fec14e4ffcd340ad7f9b59b68df6c8b1e9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-musllinux_1_2_x86_64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 1.8 MB |
| Tags | Linux musl 1.2+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
1c90fcf7d8e20bae31873a6129afb505fd75e324c087bdb614e828c5853461a2
|
|
BLAKE2b-256 checksum How to use checksums |
53b40d2ccf8503a766b9de2ff8b1a7cff9beb2080b088d0b78f5b991d9e085d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-musllinux_1_2_i686.whl
| Download URL | mdrefcheck-0.2.2-py3-none-musllinux_1_2_i686.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux musl 1.2+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
1bd3f8beeb035fbf4c9fb5bf790278ebea820527f156038746131d4584b4e175
|
|
BLAKE2b-256 checksum How to use checksums |
d8d3541b8fc468eb98ac3701e8898503eb07aea53844612ad80c85be7ec40642
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-musllinux_1_2_armv7l.whl
| Download URL | mdrefcheck-0.2.2-py3-none-musllinux_1_2_armv7l.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Linux musl 1.2+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
1cfc4bc18ab33c457a2aa8b79648baea1262ffa891f9e6d2fb117c38bb87bccd
|
|
BLAKE2b-256 checksum How to use checksums |
4068b4143877e1b81fd713e8bf5fad21072b487cee11e6db1be642c8d4569e71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-musllinux_1_2_aarch64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux musl 1.2+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
b6d49a3ce7d8951cc00b54d39ea012fdcc954632cf81201d6134d0c3b116b446
|
|
BLAKE2b-256 checksum How to use checksums |
6fb204620ff8c62ff6498b5cb79a6fedaeedff1184160213e51c64879eba687e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
4d86a9f696adc34e8e5ba3f87c0b39a8fc3d34b6fe32de017d96c63ef62eb88f
|
|
BLAKE2b-256 checksum How to use checksums |
dc304975933acfbf69161e05ed1d68ef986d6ba7ca137cf90a30ecee35ca5f71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux glibc 2.17+ IBM System/390x Python 3 |
|
SHA-256 checksum How to use checksums |
55869577ee6377835725ca44e04fa1c6878dbf8c9243d6319f8d3d5e0e737305
|
|
BLAKE2b-256 checksum How to use checksums |
2cfa419dc07d90dee04491b9172a5283602c93d729a06e1812e5e7ce2d16af5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl |
|---|---|
| Size | 2.0 MB |
| Tags | Linux glibc 2.17+ PowerPC 64-le Python 3 |
|
SHA-256 checksum How to use checksums |
f4bd7281ddcfaf9430e7fbf67af594121f65e3390db9a5334fc665ff5ae67111
|
|
BLAKE2b-256 checksum How to use checksums |
9cde8b3639568c676998d6c5bc9ba876e3c8e60de5a94f0c2b8b81973df9a9bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux glibc 2.17+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
a31d454bbb6cbed8d3e8614a53219e35f39ca1948439880a6eccb8f9c52e363c
|
|
BLAKE2b-256 checksum How to use checksums |
d58c0ea3af9e4ef6d1978fe11acaeff4de94d93ed38860e11c521a1a138052e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Linux glibc 2.17+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
3648ea7e6a9c618038ad629f1d04b086f148dd93e2d2eb83a838457c936382e9
|
|
BLAKE2b-256 checksum How to use checksums |
a435e815327721bf486f84a086594943010072a8c936aceef2a32a27c02bec4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
6725f8bd0efc7acc4e281aa942547665ec91a2bc3fde04235ec7124f55b8e97d
|
|
BLAKE2b-256 checksum How to use checksums |
164efde74ac1512601d6baa728b11969cc55dad80aee1999c5d434949b1d47d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-macosx_11_0_arm64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.5 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a8c38f940dfb1a32b6502561a968c14b8b28e8a8828ffc65a244d8b761496610
|
|
BLAKE2b-256 checksum How to use checksums |
50e5699490da1de0c1b827b7ee8d91bc552cb3c1a18b4eea91d96887784cb3d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / mdrefcheck-0.2.2-py3-none-macosx_10_12_x86_64.whl
| Download URL | mdrefcheck-0.2.2-py3-none-macosx_10_12_x86_64.whl |
|---|---|
| Size | 1.5 MB |
| Tags | Python 3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
6955f65499a345dc05154e4467e9e31e708cf5439191e1bf708b8374211c63d4
|
|
BLAKE2b-256 checksum How to use checksums |
43113e50df88cdacd804f70c3de7df0aeba5ca044464fcac62c7ed6543334236
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Security for mdrefcheck 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.