{"repo":"tcort/markdown-link-check","free":true,"listed":false,"github":"https://github.com/tcort/markdown-link-check","clone":"git clone https://github.com/tcort/markdown-link-check.git","description":"checks all of the hyperlinks in a markdown text to determine if they are alive or dead","language":"JavaScript","stars":712,"topics":["markdown","hyperlinks","checker"],"license":"ISC","category":"deployment-docker-iac","readme_excerpt":"markdown-link-check Extracts links from markdown texts and checks whether each link is alive ( 200 OK ) or dead. mailto: links are also validated. Installation To add the module to your project, run: To install the command line tool globally, run: --- Run using Docker Docker images are built with each release. Use the stable tag for the current stable release. Add current directory with your README.md file as read only volume to docker run : Alternatively, if you wish to target a specific release, images are tagged with semantic versions (i.e. 3 , 3.8 , 3.8.3 ) Run in a GitHub action Please head on to github-action-markdown-link-check. Run as a pre-commit hook To run as a pre-commit hook: Run in a GitLab pipeline Run in other tools - Mega-Linter: Linters aggregator including markdown-link-check API markdownLinkCheck(markdown, [opts,] callback) Given a string containing markdown formatted text and a callback , extract all of the links and check if they're alive or dead. Call the callback with (err, results) Parameters: markdown string containing markdown formatted text. opts optional options object containing any of the following optional fields: showProgressBar enable an ASCII progress bar. timeout timeout in ms format. (e.g. \"2000ms\" , 20s , 1m ). Default 10s . httpHeaders to apply URL specific headers, see example below. ignorePatterns an array of objects holding regular expressions which a link is checked against and skipped for checking in case of a match. Example: [{ pat","default_branch":null,"files":null,"tree":[],"storefront":"/r/tcort","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/tcort/markdown-link-check/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}