Simple CLI tool to check URL health in markdown files.
Project description
Markdown URL Checker
>> Simple CLI tool to check URL health in markdown files <<
This CLI tool traverses down a markdown file, extracts all the valid URLs, and checks whether they're accessible or not. In case it encounters a broken link, it raises an error. Internally, this is optimized for larger markdown files and tested for huge markdown files with thousands of links.
Installation
Install the CLI using pip:
pip install md-url-checker
Usage
-
To check the URLs in a single markdown file, run:
md-url-check -f file.md
-
To check the URLs in multiple markdown files, run:
echo 'file1.md file2.md' | xargs -n 1 md-url-check -f
-
To check the URLs in multiple files in a folder, run:
find . -name '*.md' | xargs -n 1 --no-run-if-empty md-url-check -f
✨ 🍰 ✨
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
md-url-check-0.1.1.tar.gz
(4.0 kB
view hashes)
Built Distribution
Close
Hashes for md_url_check-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 253fc397c4709d36d74a5a036e89e1d062dd90dc18762714d7d0653966daca15 |
|
MD5 | d94daa23a7befe216458c85a26aad2eb |
|
BLAKE2b-256 | 6de3664de32bf703eec1e0cbee9d929a95739e2e4679de002d38ec860088f116 |