{"repo":"remarkjs/remark-validate-links","free":true,"listed":false,"github":"https://github.com/remarkjs/remark-validate-links","clone":"git clone https://github.com/remarkjs/remark-validate-links.git","description":"plugin to check that markdown links and images reference existing files and headings","language":"JavaScript","stars":126,"topics":["remark","remark-plugin","markdown","link","valid"],"license":"MIT","category":"productivity","readme_excerpt":"remark-validate-links [![Build][badge-build-image]][badge-build-url] [![Coverage][badge-coverage-image]][badge-coverage-url] [![Downloads][badge-downloads-image]][badge-downloads-url] [![Size][badge-size-image]][badge-size-url] [remark][github-remark] plugin to check that markdown links and images point to existing local files and headings in a Git repo. For example, this document does not have a heading named Hello . So if we’d link to that heading ( welcome ), we’d get a warning. Links to headings in other markdown documents ( examples/foo.md#hello ) and links to files ( license or index.js ) are also checked. This is specifically for Git repos. Like this one. Not for say a website. Contents What is this? When should I use this? Install Use API [ unified().use(remarkValidateLinks[, options]) ](#unifieduseremarkvalidatelinks-options) Options UrlConfig Examples Example: CLI Example: CLI in npm scripts Integration Compatibility Security Related Contribute License What is this? This package is a [unified][github-unified] ([remark][github-remark]) plugin to check local links in a Git repo. When should I use this? This project is useful if you have a Git repo, such as this one, with docs in markdown and links to headings and other files, and want to check whether they’re correct. Compared to other links checkers, this project can work offline (making this plugin fast en prone to fewer false positives), and is specifically made for local links in Git repos. This plugin does not ch","default_branch":null,"files":null,"tree":[],"storefront":"/r/remarkjs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/remarkjs/remark-validate-links/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."}