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

0.1.5

0.1.3

This version

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.1.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.1-py3-none-win_amd64.whl (1.0 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3Windows x86

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

Uploaded Python 3musllinux: musl 1.2+ x86-64

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

Uploaded Python 3musllinux: musl 1.2+ i686

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

Uploaded Python 3musllinux: musl 1.2+ ARMv7l

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

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.17+ s390x

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

Uploaded Python 3manylinux: glibc 2.17+ ppc64le

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

Uploaded Python 3manylinux: glibc 2.17+ i686

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

Uploaded Python 3manylinux: glibc 2.17+ ARMv7l

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

mdrefcheck-0.1.1-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.1.tar.gz.

File metadata

  • Download URL: mdrefcheck-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 96d6b863c3b0878a24de602fd617d995bd7914156ab0eb56a30c1f3100aa48a5
MD5 327c6ae887b69448a0d615d9e263e7ba
BLAKE2b-256 0638649c91b307af141ca71247d4a113504544dae24df1ece69ec93d38ead36c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f22e46101eadf6d89fc0fba5a0dab708114551cd5eed67ab734f8ac3e977e57f
MD5 68c37e3aed809d070b81b50ece631872
BLAKE2b-256 c48efe80f62f6fa2adee8011877bd3564bf426f47ee349e0be584285f147db4d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdrefcheck-0.1.1-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.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 baf8dc34003bdb292acba3dc14e96f02f84c963222a0b5f6a120156f7f64ec14
MD5 5acdc33c22f47d25df4f730a01d74b37
BLAKE2b-256 7bae771592679442e677069ec8d5c5b0f5d9eb7e0eb7e33020f7fab7c2bbed5a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5f684a3272c063c327946cdbe340e673eb1fd6d0206f1c9e8b84340ce03c5a74
MD5 bf59991a94e81efe42391d478ed075c8
BLAKE2b-256 97630604805bc5dcb40b1a460ab66fdbaaf36a30874913c9ba3d6daca4caf7ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 c7f027ca20b7e3ddceb517b797430e332d19c474030e143fe448f3115e39b626
MD5 9d9e824157155b5d7a323aa8bfceaa66
BLAKE2b-256 a941da34d9924b74199d672be2fb2105a5dfd345eae3dfec90251111065f4b6a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 11ff8c8789d724bf62dceb138862c9c9ba3b35b34a6b250dd881c8466885c6af
MD5 592d4ce48df73e2b2ca5132fe478c5c4
BLAKE2b-256 03deb0cd94f5d2ebc02afb3b7510e2c0ee68c5dc739c2551d8dd061d82f578b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5005ee73c33edddcf08d45d03c56b3dcded504696ad4b36f603341309e9e3121
MD5 6c6cbd5e35e7a17f7237860665690f0b
BLAKE2b-256 421b4333f0dd2a052ffd9bcb5767ffbfb98056bad9760f69a83d1ca377ed16cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 25b4d1c39ea0c1b55d72f274a347b08054228833f2665d4457f542d6cddca85c
MD5 d5bd4dc4c2242f705045c5500e8d6c8a
BLAKE2b-256 2e194396ba711815f7bf5f9a597872d5f5ab475154fb7c98813522702d48e991

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 6d4e32c6f11ace2bb9c8fb3c0eb294515147634068d6f737c5ab76b8ba147806
MD5 f5f6f07de6eeea8bdbdcbfbb89dca006
BLAKE2b-256 b4d3d0d991f319cda19e403c045ac54ba39abe307296e98298ce8451b1b54767

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 a4d607152f4ce884c11c10eac5281e4e8aa07867e8f229291f60d02569a95e32
MD5 106a7fb34081f0b5f9e03882aff3df1f
BLAKE2b-256 c60b6e5c605368af475619f653805146ca24bf17803380b7783501f3052abe37

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 958f64a38158b5af3262f595a53ba1666bcdbe44f98c9529c605fdf6cee060d1
MD5 b4b7b2d04c23f70b615a1db6eef3b910
BLAKE2b-256 3a97dcc9456b9fb69b74e731de80dbdd4ce228edc77fd671d74fa6d47849b9ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 4b295e697198a9cd67d8eb164c7c0a6619334fa81acfe2b6629c6b3296b10455
MD5 6db1967f6bf7a57113e408f335e58898
BLAKE2b-256 6ed17a80952a75e82e47a58216635b6c5067a5b03f5842e80368bb38ee0168d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 492a15c02bcb8b7889efc3b27a1270d0ee797794f380387ce5bb9389ae5f799c
MD5 9a5d072b452c38e8570b6ef2fb3ad5f1
BLAKE2b-256 c09d67a21c6327b6d12e2a76168588b1ee885a84f63d5a558df3a43ac4e2b2a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6b55e68cda7004cbb27629243e882eb7227ebb36b114e0259a843f9eaeb1e4da
MD5 742cab93c7aaf2864136a2b979b46645
BLAKE2b-256 a7f69fcf296d1c3d21adec6201ba32a5c58cb928ac7e24b1b1d79e9798fc40e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mdrefcheck-0.1.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 716624ef10b9c823ead28aafb5c1324808093ee9e40e20853cba416adf11fd5b
MD5 095e786d5dbe91a9e6235dfc9cfba040
BLAKE2b-256 5140a9e5922869ffcfb3e29f9c1266e77deded651f4738e0f9eecf7db11ae1dd

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