| Name | md-link-checker JSON |
| Version |
1.10
JSON |
| download |
| home_page | None |
| Summary | Utility to check url, section reference, and path links in Markdown files |
| upload_time | 2025-08-14 04:20:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
markdown
github
gfm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## MD-LINK-CHECKER - Utility to check url, section reference, and path links in Markdown files
[](https://pypi.org/project/md-link-checker/)
This is a simple command line utility to check url, section reference, and path
links in Markdown files. It iterates through the specified Markdown files and
checks each link in the file for validity. If no file is specified then it
defaults to checking `README.md` in the current directory. URL network fetches
can be slow so they are checked simultaneously, doing a maximum 10 in parallel
(by default but you can change that using the `-p/--parallel-url-checks`
option). If you specify multiple files then all URLs across all files are
extracted at the start so only unique URLs are checked and network fetches are
minimised. There are a number of similar utilities available so why did I
create another one? Well, all those that I tried didn't work!
E.g. check links in the `README.md` file in the current directory:
```
$ cd /path/to/my/project
$ md-link-checker
```
Check links in all the `README.md` files across your projects:
```
$ cd ..
$ md-link-checker */README.md
```
The latest version and documentation is available at
https://github.com/bulletmark/md-link-checker.
## Installation or Upgrade
Python 3.9 or later is required. You can run
[`md-link-checker`][md-link-checker] most easily using [`uvx`][uvx]. Just make
sure [`uv`][uv] is installed and then run the following command which will
install `md-link-checker` from [PyPi][md-link-checker-py] "on the fly" and will
then run it immediately:
```sh
$ uvx md-link-checker [myfile.md]
```
Or install [`md-link-checker`][md-link-checker] formally on your system using
using [`uv tool`][uvtool] (or [`pipx`][pipx] or [`pipxu`][pipxu]). To install:
```sh
$ uv tool install md-link-checker
```
To upgrade:
```sh
$ uv tool upgrade md-link-checker
```
To uninstall:
```sh
$ uv tool uninstall md-link-checker
```
## Command Line Options
Type `md-link-checker -h` to view the usage summary:
```
usage: md-link-checker [-h] [-u] [-p PARALLEL_URL_CHECKS] [-v] [-f] [-w]
[files ...]
Utility to check url, section reference, and path links in Markdown files.
positional arguments:
files one or more markdown files to check, default =
"README.md"
options:
-h, --help show this help message and exit
-u, --no-urls do not check URL links, only check section and path
links
-p, --parallel-url-checks PARALLEL_URL_CHECKS
max number of URL checks to perform in parallel
(default=10)
-v, --verbose print links found in file as they are checked
-f, --no-fail do not return final error code after failures
-w, --no-warnings do not print warnings for ignored URLs
```
## License
Copyright (C) 2025 Mark Blakeney. This program is distributed under the terms
of the GNU General Public License. This program is free software: you can
redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation, either version 3 of the
License, or any later version. This program is distributed in the hope that it
will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License at <https://en.wikipedia.org/wiki/GNU_General_Public_License> for more
details.
[md-link-checker]: https://github.com/bulletmark/md-link-checker
[md-link-checker-py]: https://pypi.org/project/md-link-checker
[uv]: https://docs.astral.sh/uv/
[uvtool]: https://docs.astral.sh/uv/guides/tools/#using-tools
[uvx]: https://docs.astral.sh/uv/guides/tools/#using-tools
[pipx]: https://github.com/pypa/pipx
[pipxu]: https://github.com/bulletmark/pipxu
<!-- vim: se ai syn=markdown: -->
Raw data
{
"_id": null,
"home_page": null,
"name": "md-link-checker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "markdown, github, gfm",
"author": null,
"author_email": "Mark Blakeney <mark.blakeney@bullet-systems.net>",
"download_url": "https://files.pythonhosted.org/packages/f4/41/42201dab56b3a8038fe02a903f5ced3f978983f2c422eb77f2baa22b33e5/md_link_checker-1.10.tar.gz",
"platform": null,
"description": "## MD-LINK-CHECKER - Utility to check url, section reference, and path links in Markdown files\n[](https://pypi.org/project/md-link-checker/)\n\nThis is a simple command line utility to check url, section reference, and path\nlinks in Markdown files. It iterates through the specified Markdown files and\nchecks each link in the file for validity. If no file is specified then it\ndefaults to checking `README.md` in the current directory. URL network fetches\ncan be slow so they are checked simultaneously, doing a maximum 10 in parallel\n(by default but you can change that using the `-p/--parallel-url-checks`\noption). If you specify multiple files then all URLs across all files are\nextracted at the start so only unique URLs are checked and network fetches are\nminimised. There are a number of similar utilities available so why did I\ncreate another one? Well, all those that I tried didn't work!\n\nE.g. check links in the `README.md` file in the current directory:\n\n```\n$ cd /path/to/my/project\n$ md-link-checker\n```\n\nCheck links in all the `README.md` files across your projects:\n\n```\n$ cd ..\n$ md-link-checker */README.md\n```\n\nThe latest version and documentation is available at\nhttps://github.com/bulletmark/md-link-checker.\n\n## Installation or Upgrade\n\nPython 3.9 or later is required. You can run\n[`md-link-checker`][md-link-checker] most easily using [`uvx`][uvx]. Just make\nsure [`uv`][uv] is installed and then run the following command which will\ninstall `md-link-checker` from [PyPi][md-link-checker-py] \"on the fly\" and will\nthen run it immediately:\n\n```sh\n$ uvx md-link-checker [myfile.md]\n```\n\nOr install [`md-link-checker`][md-link-checker] formally on your system using\nusing [`uv tool`][uvtool] (or [`pipx`][pipx] or [`pipxu`][pipxu]). To install:\n\n```sh\n$ uv tool install md-link-checker\n```\n\nTo upgrade:\n\n```sh\n$ uv tool upgrade md-link-checker\n```\n\nTo uninstall:\n\n```sh\n$ uv tool uninstall md-link-checker\n```\n\n## Command Line Options\n\nType `md-link-checker -h` to view the usage summary:\n\n```\nusage: md-link-checker [-h] [-u] [-p PARALLEL_URL_CHECKS] [-v] [-f] [-w]\n [files ...]\n\nUtility to check url, section reference, and path links in Markdown files.\n\npositional arguments:\n files one or more markdown files to check, default =\n \"README.md\"\n\noptions:\n -h, --help show this help message and exit\n -u, --no-urls do not check URL links, only check section and path\n links\n -p, --parallel-url-checks PARALLEL_URL_CHECKS\n max number of URL checks to perform in parallel\n (default=10)\n -v, --verbose print links found in file as they are checked\n -f, --no-fail do not return final error code after failures\n -w, --no-warnings do not print warnings for ignored URLs\n```\n\n## License\n\nCopyright (C) 2025 Mark Blakeney. This program is distributed under the terms\nof the GNU General Public License. This program is free software: you can\nredistribute it and/or modify it under the terms of the GNU General Public\nLicense as published by the Free Software Foundation, either version 3 of the\nLicense, or any later version. This program is distributed in the hope that it\nwill be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public\nLicense at <https://en.wikipedia.org/wiki/GNU_General_Public_License> for more\ndetails.\n\n[md-link-checker]: https://github.com/bulletmark/md-link-checker\n[md-link-checker-py]: https://pypi.org/project/md-link-checker\n[uv]: https://docs.astral.sh/uv/\n[uvtool]: https://docs.astral.sh/uv/guides/tools/#using-tools\n[uvx]: https://docs.astral.sh/uv/guides/tools/#using-tools\n[pipx]: https://github.com/pypa/pipx\n[pipxu]: https://github.com/bulletmark/pipxu\n\n<!-- vim: se ai syn=markdown: -->\n",
"bugtrack_url": null,
"license": null,
"summary": "Utility to check url, section reference, and path links in Markdown files",
"version": "1.10",
"project_urls": {
"Homepage": "https://github.com/bulletmark/md-link-checker"
},
"split_keywords": [
"markdown",
" github",
" gfm"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "83f02c7ba0b6bbaf1062a6425b7cebb3a3cf312eb8808f78fcd6d7397554f65f",
"md5": "0b654e1dbc4acf660e68849df226cb96",
"sha256": "45ff3de402531d19815a1a25fab4bc8ae4409c4e527fc29df533004d421e48a5"
},
"downloads": -1,
"filename": "md_link_checker-1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b654e1dbc4acf660e68849df226cb96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6199,
"upload_time": "2025-08-14T04:20:53",
"upload_time_iso_8601": "2025-08-14T04:20:53.509447Z",
"url": "https://files.pythonhosted.org/packages/83/f0/2c7ba0b6bbaf1062a6425b7cebb3a3cf312eb8808f78fcd6d7397554f65f/md_link_checker-1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f44142201dab56b3a8038fe02a903f5ced3f978983f2c422eb77f2baa22b33e5",
"md5": "75aff1d9b91fff3bd26e4f54c93ac489",
"sha256": "eeff9008daa0a728902a9743e0d134fe902fa6bf21851799af23fcb815e29721"
},
"downloads": -1,
"filename": "md_link_checker-1.10.tar.gz",
"has_sig": false,
"md5_digest": "75aff1d9b91fff3bd26e4f54c93ac489",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7228,
"upload_time": "2025-08-14T04:20:54",
"upload_time_iso_8601": "2025-08-14T04:20:54.854421Z",
"url": "https://files.pythonhosted.org/packages/f4/41/42201dab56b3a8038fe02a903f5ced3f978983f2c422eb77f2baa22b33e5/md_link_checker-1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 04:20:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bulletmark",
"github_project": "md-link-checker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "md-link-checker"
}
