Skip to content

Valid use

This document demonstrates valid use of relative links within markdown as recognized by the check-relative-markdown-links tool.

  1. Simple relative links are recognised Valid use
  2. and so are links that traverse upwards Introduction
  3. even files with spaces in their name are supported! See Issues caught

Anchors

  1. Anchors can be validated Introduction#why
  2. Even duplicate anchors are supported! Introduction#why-1

Code blocks

Markdown links within code blocks are ignored so because they would not be clickable in the rendered document anyway:

[nonexistent](./non.md#existent)

Static check all the things

We can even setup static checking for relative links that we want to have as URLs for whatever reason. Simply add a comment like

<!--[README](./README.md) https://anttiharju.dev/check-relative-markdown-links/comment-trick-explained -->

alongside the URL to have the tool detect if the file gets moved in the repo. This makes refactoring project structure a lot less error-prone. Read more about this trick at https://anttiharju.dev/check-relative-markdown-links/comment-trick-explained