
Security News
npm ‘is’ Package Hijacked in Expanding Supply Chain Attack
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
markdownlint-rule-relative-links
Advanced tools
Custom rule for markdownlint to validate relative links.
Custom rule for markdownlint to validate relative links.
markdownlint-rule-relative-links is a markdownlint custom rule to validate relative links.
It ensures that relative links (using file:
protocol) are working and exists in the file system of the project that uses markdownlint.
File structure:
├── abc.txt
└── awesome.md
With awesome.md
content:
[abc](./abc.txt)
[Invalid link](./invalid.txt)
Running markdownlint-cli2 with markdownlint-rule-relative-links
will output:
awesome.md:3 relative-links Relative links should be valid ["./invalid.txt" should exist in the file system]

).markdownlint
rule - MD051 (e.g: [Link](./awesome.md#heading)
).https://example.com/
or /absolute/path.png
).<a href="./link.txt" />
or <img src="./image.png" />
).Contributions are welcome to improve the rule, and to alleviate these limitations. See CONTRIBUTING.md for more information.
Node.js >= 22.0.0
npm install --save-dev markdownlint-rule-relative-links
There are various ways markdownlint can be configured using objects, config files etc. For more information on configuration refer to options.config.
We recommend configuring markdownlint-cli2 over markdownlint-cli for compatibility with the vscode-markdownlint extension.
.markdownlint-cli2.mjs
import relativeLinksRule, { markdownIt } from "markdownlint-rule-relative-links"
const config = {
config: {
default: true,
"relative-links": true,
},
globs: ["**/*.md"],
ignores: ["**/node_modules"],
customRules: [relativeLinksRule],
markdownItFactory: () => {
return markdownIt
},
}
export default config
package.json
{
"scripts": {
"lint:markdown": "markdownlint-cli2"
}
}
node --run lint:markdown
Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
The steps to contribute can be found in the CONTRIBUTING.md file.
FAQs
Custom rule for markdownlint to validate relative links.
The npm package markdownlint-rule-relative-links receives a total of 23,374 weekly downloads. As such, markdownlint-rule-relative-links popularity was classified as popular.
We found that markdownlint-rule-relative-links demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
Security News
A critical flaw in the popular npm form-data package could allow HTTP parameter pollution, affecting millions of projects until patched versions are adopted.
Security News
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.