A CLI tool to validate references in markdown files.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gospodima from gravatar.com gospodima

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: gospodima
  • Requires: Python >=3.7
Classifiers
Report project as malware

Project description

mdrefcheck

PyPI version crates.io version Build Status License

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.7
    hooks:
      - id: mdrefcheck

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gospodima from gravatar.com gospodima

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: gospodima
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

0.2.1

0.2.0

0.1.8

This version

0.1.7

0.1.6

0.1.5

0.1.3

0.1.1

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.7.tar.gz (13.1 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

mdrefcheck-0.1.7-py3-none-win_amd64.whl (1.0 MB view details)

Uploaded Python 3Windows x86-64

mdrefcheck-0.1.7-py3-none-win32.whl (947.9 kB view details)

Uploaded Python 3Windows x86

mdrefcheck-0.1.7-py3-none-musllinux_1_2_x86_64.whl (1.4 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

mdrefcheck-0.1.7-py3-none-musllinux_1_2_i686.whl (1.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ i686

mdrefcheck-0.1.7-py3-none-musllinux_1_2_armv7l.whl (1.2 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARMv7l

mdrefcheck-0.1.7-py3-none-musllinux_1_2_aarch64.whl (1.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

mdrefcheck-0.1.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

mdrefcheck-0.1.7-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ s390x

mdrefcheck-0.1.7-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.5 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ppc64le

mdrefcheck-0.1.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl (1.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ i686

mdrefcheck-0.1.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (1.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARMv7l

mdrefcheck-0.1.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

mdrefcheck-0.1.7-py3-none-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

mdrefcheck-0.1.7-py3-none-macosx_10_12_x86_64.whl (1.3 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file mdrefcheck-0.1.7.tar.gz.

File metadata

  • Download URL: mdrefcheck-0.1.7.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.9.4

File hashes

Hashes for mdrefcheck-0.1.7.tar.gz
Algorithm Hash digest
SHA256 e9c1cb8150f8e2bdf829520d9e324fbd15838650e397067c6094edcbb0b5f3f5
MD5 5ac743e3ffed6598364ba355de2e703e
BLAKE2b-256 8d860c825670a0d9d50d76ae78381147af05ab81f2328537f45ac3843227c3bb

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 17ebf1a2ea42d6074a5373836704bb2c593529570366d13bc7d6c5a0104f7dcc
MD5 e6b72572ee4ebe03131a2dcf57db81f9
BLAKE2b-256 f37b00dfdec9ab0d71cade51f9950c3c077d967dcba83a3b3ea052af33dd16c0

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-win32.whl.

File metadata

  • Download URL: mdrefcheck-0.1.7-py3-none-win32.whl
  • Upload date:
  • Size: 947.9 kB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.9.4

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-win32.whl
Algorithm Hash digest
SHA256 aaa21dd75c8369578c3aff253e23ec3688c0aa03d809d9f61a8be5050f9855ee
MD5 14a886654be85279b7d2f1ab42f745da
BLAKE2b-256 7aed89dda520e0f1f01eaaa547d6357745b0da798ea77f3cb48109ed55387c16

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b1474557fd9a86a66b09f0960c91b7bca6a397745c38fe7c1a388caf68829058
MD5 745acf0e839148ea74bcfb46fa4575bd
BLAKE2b-256 f5e602fb8f5acafdc6de4d98a32e3d56e1f8aa6d1a50806c8cbbf54cd42c5331

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-musllinux_1_2_i686.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 9ef0e736f30b83f3fe205a1b39d3e4439114758f921467f8a25cdc9b95912dd0
MD5 106b5adcf5cb7168d709a09f75261eea
BLAKE2b-256 ef0e2dba29eb82df24ad8a87cd55aa43b2f42a61770652f1dc92baefb781103d

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-musllinux_1_2_armv7l.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 be4e57eef1582ccd69b597a301d77bd0c2da98b0a81324e6105ee1953a98c741
MD5 cbff8d9207a0e45096025ded25a6fd44
BLAKE2b-256 6df8569cabae29f9279b0e2593cb3dbeafae91a327ba835a33fa42fc5dba6fd5

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 a55c8561e45ae6b9545d3eb6620566f3ded148677edbc33bd576e90864e73f13
MD5 40f0228c76756c6586528232a4619318
BLAKE2b-256 5acf91d3b4ea61bcbfd2e6a0c9f8e14725a01540a00c272eed399c5c33f74f1f

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a0ddabd479b5fa1d0a2ff764df2b0c0681f5e20abb357793ad8e30b0942e9267
MD5 7cfe05104d46cf1c2f8c01e6d7aedbe1
BLAKE2b-256 11d97aa5e36220fa97eefe71c1734f492268a0701128341ef7c572cc0483757c

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 3c0e559403fb89aad36eb21f76ff78124b25bf46e6de9d33312c46fa71e5d9af
MD5 4117d3d8c65e8222c2ca72d26b98cdee
BLAKE2b-256 4c12b0fdc4f5a8f60909b2a9424e72d394a8afff8023bb162dd418351eba578d

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 d542b66f3888331f2b8a4e79d700a7573ec1e013685896be1444aacb15168b65
MD5 46b9443532c515c26ae5a3adb7c72c37
BLAKE2b-256 41ef82ce841394a88ff9a2ae751beef29ed34bcd71ff315bc0d1f68d36c41e64

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 834b5c7f2a907ecdd6f7ea5ddef3d21dae5df10b2373c47b21f293d01783b22e
MD5 c7d0d273489a47a5b9f433a589d1544b
BLAKE2b-256 58a18aef807a749ca11f8a21b5a1167cb2f23b905b69ac7991a7ba468a36ea9c

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 090224de8b46684cce18a4d567559c6554d3e2d2cd989a22f1a0d63bf035b73c
MD5 83327497861b34c6056894b14672e1ce
BLAKE2b-256 bfd4dba2eafdacdf1a6d5cdf2259696d214c03dcf47fa233617f717279e48c17

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 2fb90480b3bea9d039685d20fbb4205c1d731be52def693427bf657ff7bcd9bf
MD5 0d1ac6db5822b1c41167d54476042bbc
BLAKE2b-256 7aa87bd637ca228d8fbe29d8c5b60e761209394a56ed9e56bf19d4aa9e947244

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1e5698de47f1fa87170a8d94818bc070bf5085976f85096e75fd3977ee9998fd
MD5 10c80a7f11fc0b6536401f07483e59ba
BLAKE2b-256 b76478c16314619254c90eab4ba3b8455fe5461e884eec8fb8e98f44198e0416

See more details on using hashes here.

File details

Details for the file mdrefcheck-0.1.7-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for mdrefcheck-0.1.7-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 0c5d1cd2049ae92d41c6b27249438fb882305a4f4186b43360e15085f682936e
MD5 0bb3fe8970ead0ade7ba65c923bd5f31
BLAKE2b-256 3c0dec00ad27810890058ca64f1150a4343418e8e057c11ce1344f3efb855f03

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page