md-dead-link-check

A lightweight and fast tool to help you keep your Markdown files free of broken links.

MIT License

Downloads
2K
Stars
7

Bot releases are hidden (Show)

md-dead-link-check - Release v0.9 Latest Release

Published by AlexanderDokuchaev 4 months ago

0.9

  • Support headers with links and html tags
  • Support list of headers
  • Support any langues
  • Detect links with brackets
  • Detect html tags with several arguments
  • Fix crash on incorrect links
md-dead-link-check - Release v0.8

Published by AlexanderDokuchaev 6 months ago

  • Retry get request in case of head request return 404.
md-dead-link-check - Release v0.7

Published by AlexanderDokuchaev 7 months ago

  • Fixed github action to set not default config file.
  • Updated readme of usage github actions.
md-dead-link-check - Release v0.6

Published by AlexanderDokuchaev 7 months ago

0.6

  • Github Action checks web link in changed files only for pull request events.
  • Updated error messages.
  • MIT license.
md-dead-link-check - Release v0.5

Published by AlexanderDokuchaev 7 months ago

0.5

  • Fixed converting header with link to fragment.
  • Fixed parsing links for badge.
  • Check same links only one time.
  • Detection links to file that not added to repository.
  • Added warn and all arguments.
  • Removed verbose argument.

0.4

  • Remove debug output
md-dead-link-check - 0.3

Published by AlexanderDokuchaev 8 months ago

  • Multi-platform support: Added support for Windows and macOS.
  • Enhanced pre-commit hook: Set always_run: True for the pre-commit hook to ensure consistent detection of links to removed files before commit.
  • Improved output: Added coloring to the output for better readability. Disable coloring with the --no-color argument.
  • Verbose mode: Added the --verbose argument to display the status of all detected links, not just the first instance.
  • Automatic proxy detection: Uses trust_env=True for aiohttp.ClientSession to automatically detect proxy settings.
  • Extended configuration options:
    • Supports fnmatch syntax for pattern matching in configuration files.
    • Added new configuration options force_get_requests_for_links, validate_ssl, catch_response_codes.
  • Detect relative links to files that is not within repository.
  • Enhanced link detection: Improved detection of links in various formats, including:
    • [![img](img_link)](link)
    • <a href="link"></a>
    • [text](link "title")
md-dead-link-check - Init release

Published by AlexanderDokuchaev 8 months ago

Markdown dead link checker

This is a lightweight and fast tool to help you keep your Markdown files free of broken links!
It scans your Markdown files and verifies whether each link is still active, letting you know if any need attention.

Detection issues

  • Unavailable web links.
  • Incorrect links to file.
  • Not existed fragments in markdown, like [no-fragment](README.md#no-fragment).

Example of output

File: tests/test_md_files/fail.md:3 • Link: https://github.com/AlexanderDokuchaev/FAILED • Error: 404: Not Found
File: tests/test_md_files/fail.md:4 • Link: https://not_exist_github.githubcom/ • Error: 500: Internal Server Error
File: tests/test_md_files/fail.md:8 • Link: /test/fail.md1 • Error: Path does not exist
File: tests/test_md_files/fail.md:9 • Link: fail.md1 • Error: Path does not exist
File: tests/test_md_files/fail.md:13 • Link: a.md#fail • Error: Not found fragment
 Found 5 dead links 🙀