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
  • 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.0
    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

This version

0.2.0

0.1.8

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.2.0.tar.gz (16.8 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.2.0-py3-none-win_amd64.whl (1.3 MB view details)

Uploaded Python 3Windows x86-64

mdrefcheck-0.2.0-py3-none-win32.whl (1.2 MB view details)

Uploaded Python 3Windows x86

mdrefcheck-0.2.0-py3-none-musllinux_1_2_x86_64.whl (1.8 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

mdrefcheck-0.2.0-py3-none-musllinux_1_2_i686.whl (1.7 MB view details)

Uploaded Python 3musllinux: musl 1.2+ i686

mdrefcheck-0.2.0-py3-none-musllinux_1_2_armv7l.whl (1.6 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARMv7l

mdrefcheck-0.2.0-py3-none-musllinux_1_2_aarch64.whl (1.7 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

mdrefcheck-0.2.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

mdrefcheck-0.2.0-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ s390x

mdrefcheck-0.2.0-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (2.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ppc64le

mdrefcheck-0.2.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl (1.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ i686

mdrefcheck-0.2.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (1.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARMv7l

mdrefcheck-0.2.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

mdrefcheck-0.2.0-py3-none-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

mdrefcheck-0.2.0-py3-none-macosx_10_12_x86_64.whl (1.6 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for mdrefcheck-0.2.0.tar.gz
Algorithm Hash digest
SHA256 81d03c36e15871c0dc55a5bab1f467163c2c13d88fa4a0c6c99c9ca450becb83
MD5 d2c9b4ad4ada9cb8984d58011c12a4b4
BLAKE2b-256 e765ee169a173cbf055fba0b3efa48b8eccd0d6f8c6387df93c4362d874e59d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 60cb4d9f919dab1e26865f31b7eda2030e46655815ed5734d476df899091e32b
MD5 232dba3b04b90afc36c80b243cd77c1c
BLAKE2b-256 a61dee68ee84ef0701f6b369ea3cebc5455fcd4d9c34cc3b3e7b5962a2d5f60b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdrefcheck-0.2.0-py3-none-win32.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.10.2

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 e5a9bfe664490321e2f17c6728397e8358a43cb9ecd58010a48febe580d99839
MD5 7add597bfc2a5bfa410f6e02e8e2cbf5
BLAKE2b-256 79281218300934e31266997c3e8b68edccc4fff084d366080eb4cd6e55c5f958

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 7e2e918c681223a637d95564b751c093e970c128348b69f462c58bd202ff57c9
MD5 3f5eab2bb96360393415e703276ddb98
BLAKE2b-256 2d57b77a000a188fbc3b2a56ee480e09e928cdd081be8be1b8e7f597dad2f7f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 c6534ff5e2644a79f03a30c223ccc89bdfbb187ecce6e6ce399db6797d7810e3
MD5 db58cc825e0e98876cabaea3a5f9556f
BLAKE2b-256 db8a11aeacb1f52b22981538250bc9fd147f958a30adb285a06d1e7449844787

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 a23d39241910fbac9c82e21ff7133e0864464939faef5ab78185809a70f959ab
MD5 7d2bdc7991df1987220827a36f322c2d
BLAKE2b-256 6ee6d406766a809f6565cf0b8cdb52171d09cd6743595e35330745205c3ba78e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5fd3f38396597874e0951b2eda6f5da606602d2c82fa038a1cd28edeeb199141
MD5 40c40386a0aa8adba6e789a868dafaa2
BLAKE2b-256 4011f61d691e5bbeeab3e87f46339d19c3419a66c4edcf1b7e3d48b7ba8d2e66

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d03b5388edc51a9d23ea317bf580dc8ecf35d9c15e38e8673c3765a7af9e6203
MD5 42e49da235986df1a7bba8c763183fbd
BLAKE2b-256 c5ae33597c52ebfb8b42c72b9845c7f0ed9f170407d66689a2e3c8f574895717

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 f880616dd03335d813effb3ec813cf1bc59188361fb1e36d06df4e16191ae5f6
MD5 75b587db4ee89b3d9ad75aced6ab9d7a
BLAKE2b-256 c969012641fc32ebd7952c52589a80558fdbe34d41516e7fea321a03d940370d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 f5114d23a2b1fe17854778a0276d189d7796a6c111ad6ebc09ae7f6942bdada2
MD5 c01d243606a088a90e632e34d7e9d10a
BLAKE2b-256 ab13e9b8a8049f981580ed97b067f1c60a8d4c830c83bb52b827685cc79d5d6e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 c803e6c62cc34cfb05b783fb3af5d33c1a9135c461f48a5096016d8a0bc896e8
MD5 a9ec8c584d4bd8413b6ed6c50a8c499b
BLAKE2b-256 c0e70939e7574a10bc95a75bb4b623ae6a321d577cf47d37b76572d1ad6d26e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 5a718cf3c558861b465b651b84d79e233b0df81d45310567cbcb3aa1d78f6f6b
MD5 aa15e135c45992ef65c6be99260dcb4c
BLAKE2b-256 0dc53ec5bb74a363a18b8a91f7f1e0ca479805471743e3ec715e1fcd7d65cefc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 1b0fa01eab569f47df8e85c259808c8b0a1a9992e9d140ad1e10ed2a465bff7f
MD5 7d3c180146d9d648829c2efb389c63de
BLAKE2b-256 043b15c074606530c3d10df17238171eb0c03f608b78b4e99d2af89fb3cddc6c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 097af62b2647f6ed4d723718b03ec032e095de4a22599656e1965898f8c5b0e2
MD5 4e5578793b9bff7eadb174dd9df47ab7
BLAKE2b-256 f7465d4db2ff564cb1e9c7752a1830ebc20177665307a5b986980ec7c280da7f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.2.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4d0592d8c2f6873033527accaf00d98812ce69b09ebd9574616407addce0caad
MD5 36b75de67c300f305ea46c55dd7c1df2
BLAKE2b-256 f93c5a20a0cb43700273282978dd2c83f93eb5100874cdaf7ead508f875f7abd

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