A CLI tool to validate references in markdown files.
Project description
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.1
hooks:
- id: mdrefcheck
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mdrefcheck-0.2.1.tar.gz
(17.6 kB
view details)
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdrefcheck-0.2.1.tar.gz.
File metadata
- Download URL: mdrefcheck-0.2.1.tar.gz
- Upload date:
- Size: 17.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae52f21e7fc17924c641364d76fa92853eb1254103e60bc611ad991fd11c7fd8
|
|
| MD5 |
bdc236e1736401c5a38532e4ab466c9b
|
|
| BLAKE2b-256 |
b782b5c1090430094decdfd8b9460f013f0bd244602b5fed35e1b213afa69fdb
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-win_amd64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-win_amd64.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
699a644c176b27a0b65a3f8300e1d9134e886c869c49477d722bb3baf6fb3df1
|
|
| MD5 |
62f88bc255376149f665527ac20c3291
|
|
| BLAKE2b-256 |
fa4e0131a3f6b8ce082856f1f3412255657293416a50b6990716de15a026820d
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-win32.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-win32.whl
- Upload date:
- Size: 1.2 MB
- Tags: Python 3, Windows x86
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3fd6f72643be7acfc0416515199f54852b31a4b4d6939548871cb265b81975c5
|
|
| MD5 |
1fe6a7dcdd19917d07b359cfdce8976e
|
|
| BLAKE2b-256 |
dc8c9a828476cf07b80c35ad0749b154af1e6c5dd78edb23be3b6c6f5cdbea5d
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-musllinux_1_2_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-musllinux_1_2_x86_64.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3, musllinux: musl 1.2+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b104268a01a143c6126bb882bee3201a67c08634e890368caec50866fd5c0d1
|
|
| MD5 |
99447df7adfa0f46accd2f6500a18600
|
|
| BLAKE2b-256 |
0c0d07910c36db1a7ea1582c305f041d60cc4f6a9e596a9ee46eb4291158f679
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-musllinux_1_2_i686.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-musllinux_1_2_i686.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3, musllinux: musl 1.2+ i686
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e029bde06af236b768e54ed99cb203030adbdbde7eb636b405e61155f28bc36d
|
|
| MD5 |
367c1d5025d414e566e98689d4b0b3ce
|
|
| BLAKE2b-256 |
c4b59e25a7f3b2dbea396ee4ff567f7b3262e89470cf602ffb4c5c544b1def10
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-musllinux_1_2_armv7l.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-musllinux_1_2_armv7l.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3, musllinux: musl 1.2+ ARMv7l
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b837490fd664db280a440a2b0a015de97a3df232cc8c4fb87d4eacd6dc3a9fce
|
|
| MD5 |
be186aa9e02e3db026f6302b7c60cdff
|
|
| BLAKE2b-256 |
91b1f6e926020db92de469926ada3ac4b4f6ad4935700c37f7b4c3ecdbbfc37e
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-musllinux_1_2_aarch64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-musllinux_1_2_aarch64.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3, musllinux: musl 1.2+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
607ac38998298ac5210978fc7f20d1043611bbca9f374069d0ffd7ada1255ea4
|
|
| MD5 |
7a517ffb635d05221ab1b0cd33d7b200
|
|
| BLAKE2b-256 |
ab73c0d585c4a59d1f591633b774652c60e86d4e7195ffb5b1b0206ab8ed7328
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a3bb9ecf01ff7fdd74f9e0a8a603a8e64a08767a5a525ed590e1efb518e7791
|
|
| MD5 |
bc3e41c420ac855ae0d4982a3c5244ee
|
|
| BLAKE2b-256 |
debc6dbda8c52155672f223f8b6e73a6eee4d8342d2c8e8252f0b571084f0b55
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3, manylinux: glibc 2.17+ s390x
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2207062450e0370070c0d030be570aba57f81bbc6a1aef34aaa5efb61c20b45a
|
|
| MD5 |
77e403ac7c7aa436c6bd399ef2860361
|
|
| BLAKE2b-256 |
8603eddf8ced8d6062ac70cfa1144798fbde230dd75382a6f5234b1d8f0cbc42
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 3, manylinux: glibc 2.17+ ppc64le
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4ebd0f34055d7749e0e46616562374332b1662cd0a260fcf34e0ecb50c05c82
|
|
| MD5 |
9c4f671df4a4ce7e3490d3d2eb83d1ff
|
|
| BLAKE2b-256 |
05aae6806f23100d7114f46d72467d6c1db1268ce616f74b8cd32dc1e4ee54f4
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3, manylinux: glibc 2.17+ i686
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2312de7dc6b941d24619b425500fa81bdda63a126db279dfae8178eeb496d74b
|
|
| MD5 |
d388963944c5714acbf723461b3aee11
|
|
| BLAKE2b-256 |
0247a50272d079c7acba57df218c367064d5352b6646dd0e5768d16474574696
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3, manylinux: glibc 2.17+ ARMv7l
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da87a6d9c6669d5736b46430adb0be166b7ff20f1fe2596665d491d2e2234df6
|
|
| MD5 |
c52fbc91cd87a733551051f248c1b345
|
|
| BLAKE2b-256 |
f21a378418cf03e76f2005c0826be796fa7c487528e41455b7264c5a6a09ce83
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1cfdf1a9825624e78185fa712b8e74174fa32803ea2a769a994c4b7bd166f4b2
|
|
| MD5 |
8b9809947571c5adde468cb51289386c
|
|
| BLAKE2b-256 |
c3e9f0252b4a8c6426af4a16805a6fe4aa6230a88d5825ecc92d45587c44b634
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.5 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5b2ded18eb13d8f857f0e613c80056e5a95214aabcaca98e35265dd58346774
|
|
| MD5 |
821aa781af2d5b74e70a9e773fc44cdf
|
|
| BLAKE2b-256 |
c35ae09d6eb4f21242f769997843bcb72fd84e49a14447b98c97688b2741b87d
|
File details
Details for the file mdrefcheck-0.2.1-py3-none-macosx_10_12_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.2.1-py3-none-macosx_10_12_x86_64.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3, macOS 10.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cfc841c6940259e2ed17045aea0f4f55da173a16d64be318b746dd257c920e10
|
|
| MD5 |
8582d2fe4ee62727e195c18ff8aaf58a
|
|
| BLAKE2b-256 |
1b79836ba0b1c5d8e136e0100d1fd9027a2da42ab65deb902216c491aafa9dd1
|
