remarkjs/remark-validate-links remarkjs/remark-validate-links

  • Stars
    star
    109
  • Rank 319,077 (Top 7 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 9 years ago
  • Updated 7 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
remarkjs/remark-validate-links
github

remarkjs

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

plugin to check that Markdown links and images reference existing files and headings

remark-validate-links

Build Coverage Downloads Size Sponsors Backers Chat

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 it ([welcome](#hello)), 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.

Contents

What is this?

This package is a unified (remark) plugin to check local links in a Git repo.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that inspects mdast.

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 it fast en prone to fewer false positives), and is specifically made for local links in Git repos. This plugin does not check external URLs (see remark-lint-no-dead-urls) or undefined references (see remark-lint-no-undefined-references).

Install

This package is ESM only. In Node.js (version 14.14+, or 16.0+), install with npm:

npm install remark-validate-links

In Deno with esm.sh:

import remarkValidateLinks from 'https://esm.sh/remark-validate-links@11'

In browsers with esm.sh:

<script type="module">
  import remarkValidateLinks from 'https://esm.sh/remark-validate-links@11?bundle'
</script>

Use

Say we have the following file, example.md:

# Alpha

Links are checked:

This [exists](#alpha).
This [one does not](#does-not).

# Bravo

Headings in `readme.md` are [checked](readme.md#no-such-heading).
And [missing files are reported](missing-example.js).

Definitions are also checked:

[alpha]: #alpha
[charlie]: #charlie

References w/o definitions are not checked: [delta]

And a module, example.js:

import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkValidateLinks from 'remark-validate-links'

main()

async function main() {
  const file = await remark()
    .use(remarkValidateLinks)
    .process(await read('example.md'))

  console.log(reporter(file))
}

Now, running node example yields:

example.md
    6:6-6:31  warning  Link to unknown heading: `does-not`         missing-heading  remark-validate-links
  11:5-11:53  warning  Link to unknown file: `missing-example.js`  missing-file     remark-validate-links
  16:1-16:20  warning  Link to unknown heading: `charlie`          missing-heading  remark-validate-links

โš  3 warnings

(Note that readme.md#no-such-heading is not warned about, because the API does not check headings in other Markdown files).

API

This package exports no identifiers. The default export is remarkValidateLinks.

unified().use(remarkValidateLinks[, options])

Check that markdown links and images point to existing local files and headings in a Git repo.

โš ๏ธ Important: The API in Node.js checks links to headings and files but does not check whether headings in other files exist. The API in browsers only checks links to headings in the same file. The CLI can check everything.

options

Typically, you donโ€™t need to configure remark-validate-links, as it detects local Git repositories.

options.repository

URL to hosted Git (string? or false). If repository is nullish, the Git origin remote is detected. If the repository resolves to something npm understands as a Git host such as GitHub, GitLab, or Bitbucket, then full URLs to that host (say, https://github.com/remarkjs/remark-validate-links/readme.md#install) can also be checked. If youโ€™re not in a Git repository, you must pass repository: false explicitly.

options.root

A root (string?) can also be passed, referencing the local Git root directory (the folder that contains .git). If both root and repository are nullish, the Git root is detected. If root is not given but repository is, file.cwd is used.

options.urlConfig

If your project is hosted on github.com, gitlab.com, or bitbucket.org, this plugin can automatically detect the url configuration. Otherwise, use urlConfig to specify this manually. For this repository (remarkjs/remark-validate-links on GitHub) urlConfig looks as follows:

{
  // Domain of URLs:
  hostname: 'github.com',
  // Path prefix before files:
  prefix: '/remarkjs/remark-validate-links/blob/',
  // Prefix of headings:
  headingPrefix: '#',
  // Hash to top of markdown documents:
  topAnchor: '#readme',
  // Whether lines in files can be linked:
  lines: true
}

If this project were hosted on Bitbucket, it would be:

{
  hostname: 'bitbucket.org',
  prefix: '/remarkjs/remark-validate-links/src/',
  headingPrefix: '#markdown-header-',
  lines: false
}

Examples

Example: CLI

Itโ€™s recommended to use remark-validate-links on the CLI with remark-cli. Install both with npm:

npm install remark-cli remark-validate-links --save-dev

Letโ€™s say we have a readme.md (this current document) and an example.md with the following text:

# Hello

Read more [whoops, this does not exist](#world).

This doesnโ€™t exist either [whoops!](readme.md#foo).

But this does exist: [license](license).

So does this: [readme](readme.md#install).

Now, running ./node_modules/.bin/remark --use remark-validate-links . yields:

example.md
  3:11-3:48  warning  Link to unknown heading: `world`               missing-heading          remark-validate-links
  5:27-5:51  warning  Link to unknown heading in `readme.md`: `foo`  missing-heading-in-file  remark-validate-links

readme.md: no issues found

โš  2 warnings

Example: CLI in npm scripts

You can use remark-validate-links and remark-cli in an npm script to check and format markdown in your project. Install both with npm:

npm install remark-cli remark-validate-links --save-dev

Then, add a format script and configuration to package.json:

{
  // โ€ฆ
  "scripts": {
    // โ€ฆ
    "format": "remark . --quiet --frail --output",
    // โ€ฆ
  },
  "remarkConfig": {
    "plugins": [
      "remark-validate-links"
    ]
  },
  // โ€ฆ
}

๐Ÿ’ก Tip: Add other tools such as prettier or ESLint to check and format other files.

๐Ÿ’ก Tip: Run ./node_modules/.bin/remark --help for help with remark-cli.

Now you check and format markdown in your project with:

npm run format

Integration

remark-validate-links can detect anchors on nodes through several properties on nodes:

  • node.data.hProperties.name โ€” Used by mdast-util-to-hast to create a name attribute, which anchors can link to
  • node.data.hProperties.id โ€” Used by mdast-util-to-hast to create an id attribute, which anchors can link to
  • node.data.id โ€” Used potentially in the future by other tools to signal unique identifiers on nodes

Types

This package is fully typed with TypeScript. It exports an Options type, which specifies the interface of the accepted options, and an UrlConfig type, which specifies the interface of its corresponding option.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with unified version 6+, remark version 7+, and remark-cli version 8+.

Security

remark-validate-links, in Node, accesses the file system based on user content, and this may be dangerous. In Node git remote and git rev-parse also runs for processed files.

The tree is not modified, so there are no openings for cross-site scripting (XSS) attacks.

Related

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT ยฉ Titus Wormer

More Repositories

1

react-markdown

Markdown component for React
JavaScript
12,885
star
2

remark

markdown processor powered by plugins part of the @unifiedjs collective
JavaScript
7,513
star
3

remark-lint

plugins to check (lint) markdown code style
JavaScript
936
star
4

remark-gfm

remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
JavaScript
701
star
5

remark-react

Legacy plugin to transform to React โ€” please use `remark-rehype` and `rehype-react` instead
JavaScript
524
star
6

remark-toc

plugin to generate a table of contents (TOC)
JavaScript
408
star
7

awesome-remark

Curated list of awesome remark resources
374
star
8

remark-math

remark and rehype plugins to support math
JavaScript
364
star
9

remark-html

plugin to add support for serializing HTML
JavaScript
312
star
10

remark-rehype

plugin that turns markdown into HTML to support rehype
JavaScript
258
star
11

remark-frontmatter

remark plugin to support frontmatter (YAML, TOML, and more)
JavaScript
253
star
12

remark-directive

remark plugin to support directives
JavaScript
247
star
13

react-remark

React component and hook to use remark to render markdown
TypeScript
201
star
14

remark-github

remark plugin to link references to commits, issues, pull-requests, and users, like on GitHub
JavaScript
173
star
15

strip-markdown

plugin remove Markdown formatting
JavaScript
134
star
16

remark-breaks

plugin to add break support, without needing spaces
JavaScript
116
star
17

remark-man

plugin to compile markdown to man pages
JavaScript
93
star
18

remark-slug

Legacy plugin to add `id`s to headings โ€” please use `rehype-slug`
JavaScript
89
star
19

remark-lint-no-dead-urls

Ensure that external links in your Markdown are alive
JavaScript
77
star
20

remark-unwrap-images

plugin to remove the wrapping paragraph for images
JavaScript
75
star
21

remark-highlight.js

Legacy plugin to highlight code blocks with highlight.js โ€” please use `rehype-highlight` instead
JavaScript
70
star
22

remark-autolink-headings

Legacy remark plugin to automatically add links to headings โ€” please use `rehype-autolink-headings` instead
JavaScript
64
star
23

remark-external-links

Legacy plugin to automatically add target and rel attributes to external links โ€” please use `rehype-external-links` instead
JavaScript
56
star
24

vscode-remark

Lint and format markdown code with remark
JavaScript
54
star
25

remark-vdom

Legacy plugin to compile Markdown to Virtual DOM โ€” please use `remark-rehype` and then something like `rehype-react`
JavaScript
45
star
26

remark-usage

plugin to add a usage example to your readme
JavaScript
42
star
27

remark-gemoji

plugin to turn gemoji shortcodes into emoji ๐Ÿ‘
JavaScript
41
star
28

remark-footnotes

Legacy plugin to add support for pandoc footnotes โ€” please use `remark-gfm` instead
JavaScript
40
star
29

remark-images

plugin to add a simpler image syntax
JavaScript
35
star
30

remark-textr

plugin to make your typography better with Textr
JavaScript
35
star
31

remark-language-server

A language server to lint and format markdown files with remark
JavaScript
33
star
32

remark-embed-images

plugin to embed local images as data URIs
HTML
33
star
33

remark-jsx

A simple way to use React inside Markdown.
JavaScript
28
star
34

remark-reference-links

plugin to change links and images to references with separate definitions
JavaScript
25
star
35

remark-retext

plugin to transform from remark (Markdown) to retext (natural language)
JavaScript
25
star
36

remark-inline-links

plugin to change references and definitions into normal links and images
JavaScript
23
star
37

remark-contributors

plugin to generate a list of contributors
JavaScript
22
star
38

remark-license

plugin to generate a license section
JavaScript
19
star
39

remark-defsplit

plugin to change links and images to references with separate definitions
JavaScript
19
star
40

remark-bookmarks

plugin to manage links
JavaScript
15
star
41

remark-comment-config

plugin to configure remark with comments
JavaScript
14
star
42

remark-git-contributors

plugin to generate a list of Git contributors
JavaScript
12
star
43

remark-normalize-headings

plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly
JavaScript
11
star
44

remark-squeeze-paragraphs

plugin to remove empty (or white-space only) paragraphs
JavaScript
10
star
45

remark-strip-badges

plugin to strip badges (such as shields.io)
JavaScript
9
star
46

gulp-remark

Legacy Gulp plugin for remark โ€” please use npm scripts and the like
JavaScript
9
star
47

remark-yaml-config

plugin to configure remark with YAML frontmatter
JavaScript
8
star
48

remark-message-control

plugin to enable, disable, and ignore messages
JavaScript
8
star
49

.github

Community health files for remark
TypeScript
7
star
50

remark-unlink

plugin to remove all links, images, references, and definitions
JavaScript
6
star
51

remark-heading-gap

plugin to adjust the gap between headings in markdown
JavaScript
6
star
52

ideas

Share ideas for new utilities and tools built with @remarkjs
5
star
53

remark-word-wrap

Please use something like https://github.com/prettier/prettier instead
JavaScript
4
star
54

grunt-remark

Grunt task for remark
4
star
55

remark-midas

plugin to highlight CSS code blocks with midas
3
star
56

remark-comment-blocks

Use something like https://github.com/3rd-Eden/commenting instead
JavaScript
2
star
57

governance

How @remarkjs and the projects under it are governed
2
star