Skip to main content

A CLI tool to validate references in markdown files.

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


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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3Windows x86

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

Uploaded Python 3musllinux: musl 1.2+ x86-64

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

Uploaded Python 3musllinux: musl 1.2+ i686

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

Uploaded Python 3musllinux: musl 1.2+ ARMv7l

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

Uploaded Python 3musllinux: musl 1.2+ ARM64

mdrefcheck-0.1.3-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.3-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ s390x

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

Uploaded Python 3manylinux: glibc 2.17+ ppc64le

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

Uploaded Python 3manylinux: glibc 2.17+ i686

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

Uploaded Python 3manylinux: glibc 2.17+ ARMv7l

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

mdrefcheck-0.1.3-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.3.tar.gz.

File metadata

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

File hashes

Hashes for mdrefcheck-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1c8fbd0a43dd82790ea77fc5aabecad2ba50a0a00967f3e0fafd5e0b330c0f7a
MD5 8eca74f7aeae24aab32cb6ddcd2c79e9
BLAKE2b-256 54fa6e43e9c59dc77abd6fa864d5de0bbdc397e1114ac22e49eade31b08d84d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0109686aa745a852ebb01a3b32b1f897bf506c726d70c825114af67e502b6cba
MD5 9079b1cfdd1aab3890ba55816ee69223
BLAKE2b-256 446bff26472d7b34195f80076da74a5b331f731a040239373e126ad428f24338

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdrefcheck-0.1.3-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.3-py3-none-win32.whl
Algorithm Hash digest
SHA256 f5a60808a49248de55e5c3eefbe4885de512403e08a98ddcf597a5e7c6ce0840
MD5 4ddea5e250b8bfa71c0d6bc6381c504c
BLAKE2b-256 7c51b636d5ceaf32ca91688f3c2676dfe26d19970efd23cf3cfd81b70fe8e09d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 ff841209ffdce92b8cea39abd71f27be994e849a931b36da7810b14ea98f9a21
MD5 d81c1eb538ccee157ab201fed4812126
BLAKE2b-256 5a82b3a1f11dd35885e046c01458bacf413b59d8dfc4b322fabbd1ada40d8b0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 60e9a819b4c51a496483b3349eb8e7fbaa56dca66e6f8cdf6ce74393b16ac472
MD5 df27a74de7323d1d0e86e2d78ac1af19
BLAKE2b-256 bf41e494dffa77605a5e20df87bb861861b589751144f7ca84474f4b17be16e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 e6a288d2597de0d8926a4ffcfa3ca7ec4fa2b1aa0fe6667fda3b9ed4e7eceff5
MD5 796191fd71271aa8027c4a2d575553ca
BLAKE2b-256 d9310ae70a09ad5d04a123285ae0231aed28d59266246aed99f16767b5e1acf1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 73df13960d99dd53056fd509f79ea1b53364c2f81947d492c2deb96fb4463fb5
MD5 71e0f72c0fe0700acfe15db98897f616
BLAKE2b-256 048285385a1a1e15fad1c001f52bdc1ba26cd1fe83f36dbb12ab5374a72bcfe0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6f8a9a631ff999e2f6020fd1b2c7f9088badc7e4b44465ebf16d3fa369679fe2
MD5 b4cc046519b111f5a8ffc4d00ee41179
BLAKE2b-256 5a1551a09ba9eb25db348c43748dbcb86d599c45ccfae38f7957dff7b69e9f53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 29500a2c74dbd6885206991bf1f8555c48b38480d22b866c3674504b64659389
MD5 3cc6a6839df5397deb31ce473f69274a
BLAKE2b-256 d053f98e86ad7349966ee8e508e4858e38d2faaee303e90ee0019f7c97bcfe39

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 9b983f9c9f20cb5c206a59fefd7a648b113c269d112e857ba305bd120b795efb
MD5 54e396f90bd6ae052e718a1669a53d8a
BLAKE2b-256 17e40a0c2d63374875c2961a55cb86d4568c4e16e11116f5f94d7bfac871cdbb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 15b459e0adab615ea244ad4a7a1209aff5aa3ac1215d134aa208eba0afe39b66
MD5 0abb2901ab36ddec3ee1c72a2fa160e2
BLAKE2b-256 7dcd89d9891159a5e776da9a3d4e06b8fdd4efb5cf0008eb182e64487ebd94bf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 c886ace33a46b78eeee4458200ba25294186d7e42f2d576bff0da34d1df4d2fc
MD5 adced94c9ffb922b14bb115eca7d7103
BLAKE2b-256 bf815b435da0a3d8cd45725ea56e55b0a4ad08f6b528c9d8336a813eb0da694a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 ee6ae558cef2c74ce9a48e361249999685a7e1cacf2f078643c4e50014ab4b63
MD5 781bece86bd6c86a6582617e9ee31368
BLAKE2b-256 b98878e4bdbfbb0185d0e2dd1948a0bcc52532d8ea10e5aa5e6b8ac6fb04e0dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2f6dbb40d0fb6da63dd945080866f445f057e786a3ddeb8347caf1f8d5339e28
MD5 d538dcc96e06a671ab1d071db41a68b0
BLAKE2b-256 621ce79f1bee0c5edb5b641b4d19bfbe63f83d0a5fc388550aa7ba4550e75f99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.3-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 03cdf7431772d0b670e5062b48a2df2e8a0a48b6ef08070af9e46b33841960c1
MD5 d7988f4c18971a585dd223eb733af692
BLAKE2b-256 df5cae1d081f8b0e998b28f2e390777425cad6f1efbbd26baf069eb3124f4771

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