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
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.1.8
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.1.8.tar.gz
(13.2 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
mdrefcheck-0.1.8-py3-none-win32.whl
(948.0 kB
view details)
File details
Details for the file mdrefcheck-0.1.8.tar.gz.
File metadata
- Download URL: mdrefcheck-0.1.8.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b04f2e882ed209d896b866b98730b7b7d350928dd96d5517ea2aa21f032f81e9
|
|
| MD5 |
9dbd2f556a60a49601559b5554319b83
|
|
| BLAKE2b-256 |
1bde0a1c719e7c0fce71cfa611d1df038902e9a89ffa478d1e0c87a8135d2ff9
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-win_amd64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-win_amd64.whl
- Upload date:
- Size: 1.0 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3cbd400607bc6ddb9910605a04fcea83bd894b9c7299586e6f2fdceaaaff3f05
|
|
| MD5 |
21016a8f90dc246c491d0a1161063777
|
|
| BLAKE2b-256 |
3b8cb1cb36b94eb7fd16930388a8797d1386111e4b40fbefabbf28dd0707b885
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-win32.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-win32.whl
- Upload date:
- Size: 948.0 kB
- Tags: Python 3, Windows x86
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8dfab21d53c1a7b111f6385129b97647336a3ce97bc201ea8888827303e07473
|
|
| MD5 |
b93f49123bff3c50271445e729c673a2
|
|
| BLAKE2b-256 |
dfa5208cdcecd8baf91b81b67e32a1ca34b582667d72e4a82e6f3ecba6116db4
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-musllinux_1_2_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-musllinux_1_2_x86_64.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3, musllinux: musl 1.2+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
85c3dca6bd46e756df15ec9affa462a4badb14a82bb289e32345dc67bbfdee3c
|
|
| MD5 |
21ab7becb38de377e0358b6c86efc06d
|
|
| BLAKE2b-256 |
c7dccb84a4e34656bfe8430dfb0aa7a79c38a08c148825bb7da33b928a2515e0
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-musllinux_1_2_i686.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-musllinux_1_2_i686.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, musllinux: musl 1.2+ i686
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
419c7a9f7baa4ce5ef018eb116f74bdeec42d3e49ef1aad4e671973079327f8f
|
|
| MD5 |
83a0a7a8198f0135556e127068d0ff0c
|
|
| BLAKE2b-256 |
cb3a4d079e9dbb21f269bf10553626efe54b558bcae73621d707cbe943a3a7e2
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-musllinux_1_2_armv7l.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-musllinux_1_2_armv7l.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, musllinux: musl 1.2+ ARMv7l
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
26f1a78156ab742a081ba6de3608a632293271b066e5f048de0c7f1234439085
|
|
| MD5 |
b060fa8bf3c39c24c424c2a8952431e7
|
|
| BLAKE2b-256 |
cc6cb158b4d9d5c9fd281f4c59c95d7c69aa2ed3a3640b82a288591af388de44
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-musllinux_1_2_aarch64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-musllinux_1_2_aarch64.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, musllinux: musl 1.2+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f1a321426405c7124e7ce2a1476e4af67a146c064e06020628246c2393691f6
|
|
| MD5 |
a06066dec61b5cd09c6e1da1287adc00
|
|
| BLAKE2b-256 |
a49f06fcd2f1ef323ce9dc5f83044affa7abec43f67ecd075bf58584a8dee747
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6341b651bf6c2486b02c1cc0f361edae25f7c003ff1f2b2e9a270a27d101dc36
|
|
| MD5 |
957ccacc84e5cbb90b5973703fb7ad2d
|
|
| BLAKE2b-256 |
3eedd24dbeb93b1f757233117cb8a010f23e262281267458868bfb198f22d4e7
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3, manylinux: glibc 2.17+ s390x
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4ae49d3bab3452030625d376a4a42d990894eaa704e9b43f291a8be2fa62a137
|
|
| MD5 |
29e8a8deb5bbd00e2cf6aa193cbcc90c
|
|
| BLAKE2b-256 |
c69eeac1c7f831924447523c8029b6c4ea3ef9a2664ffe73dc88bf9149b6c79a
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
- Upload date:
- Size: 1.5 MB
- Tags: Python 3, manylinux: glibc 2.17+ ppc64le
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c89a4a178aa3bc1d00de0ce7dfb85cc9f403c589a2eed08c103159dce40a2576
|
|
| MD5 |
327dbf6f05d7b29973789233793b2515
|
|
| BLAKE2b-256 |
fbcca82462dd20cba0aa5c1173b273e1d1ecbfd993de5395529eeb876144f9fc
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3, manylinux: glibc 2.17+ i686
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e5b52c6fab7ead55880024f37ae01e57b3c56fefb4cf3feb829402c060c5ad26
|
|
| MD5 |
52caeec1b32aed1e7c90c6a140a5b7bd
|
|
| BLAKE2b-256 |
e1eb317365f8fd2a91a9e077aebedfb1812fce9b39df7df7b4a27b5cabc1fbc0
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
- Upload date:
- Size: 1.2 MB
- Tags: Python 3, manylinux: glibc 2.17+ ARMv7l
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28df5a53323cb3f4d7d2c7dcc938a71e724b0e135830cf7b633d9aeafd63e147
|
|
| MD5 |
fb17f9cc03f0408d60471ddc5bcae467
|
|
| BLAKE2b-256 |
23ad706dbf746046bd6a8b573466f4caaa64aa47eceea295efc61894f0f37ded
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
beb32271dab73a692e2e98953fbd7785d6ebb282c610f1b265b05fef8010f9cb
|
|
| MD5 |
b200c79742efe9d40dfd707b50afeb4e
|
|
| BLAKE2b-256 |
ccd3f5c9ca396fd840e1d3fdc5c18e2e2333f3e0b57f0abc8ba6cf14c448ace4
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.2 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0147db4ed0188ab77ee44d55ca4ca688203b939f0b3ea451fc4d54b11d236f3
|
|
| MD5 |
01fe731740d5b92f5fb4479069df5982
|
|
| BLAKE2b-256 |
cb6cb3f764bf5f2099a8c1ed75271c2e3dcfb87c4fdde26e3f34874b035cc19b
|
File details
Details for the file mdrefcheck-0.1.8-py3-none-macosx_10_12_x86_64.whl.
File metadata
- Download URL: mdrefcheck-0.1.8-py3-none-macosx_10_12_x86_64.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3, macOS 10.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3c17ee4016c9dae5d95f901ba7bf79dadede4a7ff0d8f33211fbdb33e553060
|
|
| MD5 |
237f411bc7494f66ca2707a49e390972
|
|
| BLAKE2b-256 |
112c8ccf6fc041c08ca334190f6b7ec64f47b2f724cb81e1457a3a5948f00588
|
