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

mdrefcheck is a CLI tool to validate references and links in Markdown files (CommonMark spec).
It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.

Features

  • Validate local file paths in image and section references
  • Check section links (#heading-link) match existing headings according to GitHub Flavored Markdown (GFM) rules
  • Identify broken reference-style links
  • Email validation

Installation

From PyPI:

pip install 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

0.1.7

0.1.6

This version

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.5.tar.gz (12.6 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.5-py3-none-win_amd64.whl (1.0 MB view details)

Uploaded Python 3Windows x86-64

mdrefcheck-0.1.5-py3-none-win32.whl (946.4 kB view details)

Uploaded Python 3Windows x86

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

Uploaded Python 3musllinux: musl 1.2+ x86-64

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

Uploaded Python 3musllinux: musl 1.2+ i686

mdrefcheck-0.1.5-py3-none-musllinux_1_2_armv7l.whl (1.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARMv7l

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

Uploaded Python 3musllinux: musl 1.2+ ARM64

mdrefcheck-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ s390x

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

Uploaded Python 3manylinux: glibc 2.17+ ppc64le

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

Uploaded Python 3manylinux: glibc 2.17+ i686

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

Uploaded Python 3manylinux: glibc 2.17+ ARMv7l

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

mdrefcheck-0.1.5-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.5.tar.gz.

File metadata

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

File hashes

Hashes for mdrefcheck-0.1.5.tar.gz
Algorithm Hash digest
SHA256 737f524cecaf75a9a74b0750d4a7740af7996abefb839badbe6dbc6536eb93a4
MD5 fd9c1cc25b079da820a3d36b49390e47
BLAKE2b-256 f89a97b35193c09215677e99e510b0963eafe6464047260478d76a3c7de268a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 9df8fc4f98f577913a3bc8b6565676861938ad94bcb4f4130bbc06add78a6687
MD5 1c50cfef22b1ce9f936263c47e9cc4c4
BLAKE2b-256 ff5f15110fb97b9e7a2b66c0c55fc8087ef3d2d18e2debb46273e7a3d848f7bc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-win32.whl
Algorithm Hash digest
SHA256 71aee65633b35e8645d30e1aae2a40c063d3553c88258729478324c774a179da
MD5 0a7d17e5ab0facae2ea817bfc40c0e8b
BLAKE2b-256 b29ab14ca85d1c36338d5e831e9db1939478b11fe0606d331d6ef35132be9686

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 4d4aa72aeccaf0eaf8118529b4457ceea3749a822692f76508e2061fcec2511a
MD5 23526be97eafb7012a5a2ef91cfc20b4
BLAKE2b-256 ff921b38d09f10629e2a659ed8a63871e7e830a5eddb366bdaddfd6f04205500

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 e83e0048ad50e46b7ac6aa6b58b71413290e26de13a21e07057003f6c7e21d95
MD5 4e06c3273c1c124d7bc6bbfbfc35266d
BLAKE2b-256 0e740f8262f836de3c387fc94821fe78f5dbe6c640ca56e9e2454ecd7e862eb3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 9e712e3fb454586e4e6985a6ec684d5cf47b84f68beebaa734cd549abad5a425
MD5 75d7b08899c8b8531bff46b3cbd41a63
BLAKE2b-256 6c44fe4ca7aa78858209dc3cd82ee545bd2e7b65fbbfe627996579ef95331615

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 de400483a026299e5d0d1fdfe14a8c3361b1d78ab6f36583e74ec38b9306d6ea
MD5 642680a6abd914283fbe40f82ffdaeaa
BLAKE2b-256 e82dd37ab398965314ea68ff49d9b607b05b99d0ac4b9cbadb2d2a5083e16324

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 678f4b7ba1be6160bc4afc7a78e7e7d7dc159a50cc99bf0cb80a31baf82669ce
MD5 d845524bfe7ecc76de1e93711347bc5d
BLAKE2b-256 90a9927c2582ce2f7444ef6cba3bc0fbc6165d6872b89f2d23c1cbe641d409a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 19e52bd1d7fab747274c14d2179d492829334b0c3ceb52b0d03c7ba238f5b8c6
MD5 8282361ee7b1bfe2b3816db7f96d5118
BLAKE2b-256 942a340252e23d9a9d8c2ce06687e57f7d4d2c064b96450b3b5088f416cc830d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 b9cc31260f97519c36990d7e6cdfd114dccc6c06d817467d132a9f27db19eac1
MD5 1e01b1b9ad718b7a1f25809541c2d9ea
BLAKE2b-256 12f9032e1e7fc5b158ae0bb0d9415f93a5e529b900816082a8b53de63ad6c049

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 ced72d76612d2401bc5261f802eefa15ffcf030b5eac21fabe5b5c2beb15039a
MD5 1d27a9545baea44cb397f8bfb42d8590
BLAKE2b-256 b04798e8ead8c3344716bdf78d5958f9d9bb6564a28dac50eb8714fca03f11fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 9b74a102028ff15b7ef9989c607b1384b4e33a7c96f341f23749790113d24c0d
MD5 9a41ef39bc459157e11dbc99264a8fc7
BLAKE2b-256 28526c8ad31a715f2c77ee797e62c6ecc338bd67a9328b31eca1bb9252d5ea5f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 175baca929e0cf6b9cb994d3c5ba4b1d5e188b6b94470dfbe2a2e36754b9071c
MD5 49ed3af779ae8693915ad16be83fd6ab
BLAKE2b-256 148f3c843538573cc7880939249a8a7d664f3a062004285994f4fb31d00937f0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7fbef1b51743d3218c78570e7d9696f6ac68fe90008c4c9ff365ec6968bca2c9
MD5 fbedc5acc21758db2e7026aa4fed693d
BLAKE2b-256 18753e81f893f0728c031c927c78e34a8d3776498a6304d5e0dd03f71d3bd51d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.5-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 305b398b6f1b54402174db1720fde70e1f7c53929182b17fc9922172388aea6d
MD5 727c55d2086ebb06a19c2e92ed0c47df
BLAKE2b-256 3a98a3beb3e985d02f0dc5c9a2fe5d1bd8bf794a904e88dca0ef9c5ea3fb4d4e

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