Add the plugin to your .remarkrc or remark.config.js:
{ "plugins": ["@node-core/remark-lint"]}
Run remark to lint your Markdown files:
npx remark . --frail
Configuration
Released Versions
Some rules, such as node-core:yaml-comments, validate version references against known released Node.js versions. You can provide these using the releasedVersions option:
Checks that local links point to existing files and that fragment-only links
point to headings in the current document. Root-relative website routes are
mapped to the configured content and public directories, and route targets do
not need to include a file extension. Directory routes resolve to index.*.
For example, /about/previous-releases resolves to
pages/en/about/previous-releases.mdx.
node-core:required-metadata
Requires essential metadata for documentation:
llm_description: A description for Large Language Models (can be inferred from first paragraph)
introduced_in: API introduction version
Metadata can be provided in comments:
<!-- llm_description= Utilities for working with file paths -->
node-core:yaml-comments
Enforces structure and content of YAML comment blocks:
added: An array of valid version strings
napiVersion: The N-API version
deprecated: An array of valid version strings
removed: An array of valid version strings
changes: An array of:
pr-url: Pull request URL
commit: Commit hash (only required for security fixes)
version: Valid version string
description: Change description
All version references must be valid SemVer, or match the provided releasedVersions.