markdown-link-check

![Test library workflow status](https://github.com/tcort/markdown-link-check/actions/workflows/ci.yml/badge.svg) # markdown-link-check Extracts links from markdown texts and checks whether each link is alive (`200 OK`) or dead. `mailto:` links are validated with [isemail](https://www.npmjs.com/package/isemail). ## Installation To add the module to your project, run: ```shell npm install --save-dev markdown-link-check ``` To install the command line tool globally, run: ```shell npm install -g markdown-link-check ``` --- ## 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`: ```shell docker run -v ${PWD}:/tmp:ro --rm -i ghcr.io/tcort/markdown-link-check:stable /tmp/README.md ``` 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](https://github.com/gaurav-nelson/github-action-markdown-link-check). ## Run as a pre-commit hook To run as a [pre-commit hook](https://pre-commit.com): ``` - repo: https://github.com/tcort/markdown-link-check rev: ... hooks: - id: markdown-link-check args: [-q] ``` ## Run in a GitLab pipeline ```yaml linkchecker: stage: test image: name: ghcr.io/tcort/markdown-link-check:3.11.2 entrypoint: ["/bin/sh", "-c"] script: - markdown-link-check ./docs rules: - changes: - "**/*.md" ``` ## Run in other tools - [Mega-Linter](https://megalinter.io/latest/): Linters aggregator [including markdown-link-check](https://megalinter.io/latest/descriptors/markdown_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 [zeit/ms](https://www.npmjs.com/package/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: `[{ pattern: /foo/ }]` * `replacementPatterns` an array of objects holding regular expressions which are replaced in a link with their corresponding replacement string. This behavior allows (for example) to adapt to certain platform conventions hosting the Markdown. The special replacement `{{BASEURL}}` can be used to dynamically link to the base folder (used from `projectBaseUrl`) (for example that `/` points to the root of your local repository). Example: `[{ pattern: /^.attachments/, replacement: "file://some/conventional/folder/.attachments" }, { pattern: ^/, replacement: "{{BASEURL}}/"}]`. You can add `"global": true` to use a global regular expression to replace all instances. * `projectBaseUrl` the URL to use for `{{BASEURL}}` replacement * `ignoreDisable` if this is `true` then disable comments are ignored. * `retryOn429` if this is `true` then retry request when response is an HTTP code 429 after the duration indicated by `retry-after` header. * `retryCount` the number of retries to be made on a 429 response. Default `2`. * `fallbackRetryDelay` the delay in [zeit/ms](https://www.npmjs.com/package/ms) format. (e.g. `"2000ms"`, `20s`, `1m`) for retries on a 429 response when no `retry-after` header is returned or when it has an invalid value. Default is `60s`. * `aliveStatusCodes` a list of HTTP codes to consider as alive. Example: `[200,206]` * `callback` function which accepts `(err, results)`. * `err` an Error object when the operation cannot be completed, otherwise `null`. * `results` an array of objects with the following properties: * `link` the `link` provided as input * `status` a string set to either `alive`, `ignored` or `dead`. * `statusCode` the HTTP status code. Set to `0` if no HTTP status code was returned (e.g. when the server is down). * `err` any connection error that occurred, otherwise `null`. #### Disable comments You can write html comments to disable markdown-link-check for parts of the text. `` disables markdown link check. `` reenables markdown link check. `` disables markdown link check for the next line. `` disables markdown link check for this line. ## Examples ### Module **Basic usage:** ```js 'use strict'; var markdownLinkCheck = require('markdown-link-check'); markdownLinkCheck('[example](http://example.com)', function (err, results) { if (err) { console.error('Error', err); return; } results.forEach(function (result) { console.log('%s is %s', result.link, result.status); }); }); ``` **With options, for example using URL specific headers:** ```js 'use strict'; var markdownLinkCheck = require('markdown-link-check'); markdownLinkCheck('[example](http://example.com)', { httpHeaders: [{ urls: ['http://example.com'], headers: { 'Authorization': 'Basic Zm9vOmJhcg==' }}] }, function (err, results) { if (err) { console.error('Error', err); return; } results.forEach(function (result) { console.log('%s is %s', result.link, result.status); }); }); ``` ### Command Line Tool The command line tool optionally takes 1 argument, the file name or http/https URL. If not supplied, the tool reads from standard input. #### Check links from a markdown file hosted on the web ```shell markdown-link-check https://github.com/tcort/markdown-link-check/blob/master/README.md ``` #### Check links from a local markdown file ```shell markdown-link-check ./README.md ``` #### Check links from a local markdown folder (recursive) This checks all files in folder `./docs` with file extension `*.md`: ```shell markdown-link-check ./docs ``` The files can also be searched for and filtered manually: ```shell find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check ``` #### Usage ```shell Usage: markdown-link-check [options] [filenameOrDirectorynameOrUrl] Options: -p, --progress show progress bar -c, --config [config] apply a config file (JSON), holding e.g. url specific header configuration -q, --quiet displays errors only -v, --verbose displays detailed error information -a, --alive <code> comma separated list of HTTP code to be considered as alive -r, --retry retry after the duration indicated in 'retry-after' header when HTTP code is 429 -h, --help display help for command -V, --version display version string (e.g. `1.2.3`) , --projectBaseUrl <url> the URL to use for {{BASEURL}} replacement ``` ##### Config file format `config.json`: * `ignorePatterns`: An array of objects holding regular expressions which a link is checked against and skipped for checking in case of a match. * `replacementPatterns`: An array of objects holding regular expressions which are replaced in a link with their corresponding replacement string. This behavior allows (for example) to adapt to certain platform conventions hosting the Markdown. The special replacement `{{BASEURL}}` can be used to dynamically link to the current working directory (for example that `/` points to the root of your current working directory). This parameter supports named regex groups the same way as `string.replace` [method](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#specifying_a_string_as_the_replacement) in node. * `httpHeaders`: The headers are only applied to links where the link **starts with** one of the supplied URLs in the `urls` section. * `timeout` timeout in [zeit/ms](https://www.npmjs.com/package/ms) format. (e.g. `"2000ms"`, `20s`, `1m`). Default `10s`. * `retryOn429` if this is `true` then retry request when response is an HTTP code 429 after the duration indicated by `retry-after` header. * `retryCount` the number of retries to be made on a 429 response. Default `2`. * `fallbackRetryDelay` the delay in [zeit/ms](https://www.npmjs.com/package/ms) format. (e.g. `"2000ms"`, `20s`, `1m`) for retries on a 429 response when no `retry-after` header is returned or when it has an invalid value. Default is `60s`. * `aliveStatusCodes` a list of HTTP codes to consider as alive. * `projectBaseUrl` the URL to use for `{{BASEURL}}` replacement **Example:** ```json { "projectBaseUrl":"${workspaceFolder}", "ignorePatterns": [ { "pattern": "^http://example.net" } ], "replacementPatterns": [ { "pattern": "^.attachments", "replacement": "file://some/conventional/folder/.attachments" }, { "pattern": "^/", "replacement": "{{BASEURL}}/" }, { "pattern": "%20", "replacement": "-", "global": true }, { "pattern": "images/(?<filename>.*)", "replacement": "assets/$<filename>" } ], "httpHeaders": [ { "urls": ["https://example.com"], "headers": { "Authorization": "Basic Zm9vOmJhcg==", "Foo": "Bar" } } ], "timeout": "20s", "retryOn429": true, "retryCount": 5, "fallbackRetryDelay": "30s", "aliveStatusCodes": [200, 206] } ``` ## Testing ```shell npm test ``` ## License See [LICENSE.md](https://github.com/tcort/markdown-link-check/blob/master/LICENSE.md)