package
No description provided.
npm install @node-core/remark-lintGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
@node-core/remark-lintA remark-lint plugin with configurations tailored to the documentation and contribution standards of the Node.js GitHub Organization.
npm install --save-dev @node-core/remark-lintAdd the plugin to your .remarkrc or remark.config.js:
{
"plugins": ["@node-core/remark-lint"]
}Run remark to lint your Markdown files:
npx remark . --frailSome rules, such as node-core:yaml-comments, validate version references against known released Node.js versions. You can provide these using the releasedVersions option:
{
"plugins": [
[
"@node-core/remark-lint",
{
"releasedVersions": ["v18.0.0", "v18.1.0", "v18.2.0", "v20.0.0"]
}
]
]
}For Node.js projects, these versions can be automatically generated using list-released-versions-from-changelogs.mjs.
If not specified, version-related rules will accept any valid SemVer format.
node-core:duplicate-stability-nodesPrevents redundant stability markers in nested sections.
Not allowed:
# Parent Section
> Stability: 2 - Stable
## Child Section
> Stability: 2 - Stable <!-- Redundant! -->node-core:invalid-type-referenceEnsures that all {type} references are valid types and formatted correctly.
Allowed:
This is usually a {boolean}, but it could also be a {string|number}.Not allowed:
This is an {invalid} type, and so is {string | number} because there should **not** be whitespace around the `|`.node-core:hashed-self-referenceEnsures self-references use fragment-only links.
Allowed:
See the [Introduction](#introduction) section.Not allowed:
See the [Introduction](document.md#introduction) section.node-core:ordered-referencesEnforces alphabetical sorting of reference-style link definitions.
Allowed:
[api]: https://example.com/api
[docs]: https://example.com/docs
[info]: https://example.com/infonode-core:validate-linksChecks 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-metadataRequires essential metadata for documentation:
llm_description: A description for Large Language Models (can be inferred from first paragraph)introduced_in: API introduction versionMetadata can be provided in comments:
<!-- llm_description= Utilities for working with file paths -->node-core:yaml-commentsEnforces structure and content of YAML comment blocks:
added: An array of valid version stringsnapiVersion: The N-API versiondeprecated: An array of valid version stringsremoved: An array of valid version stringschanges: An array of:
pr-url: Pull request URLcommit: Commit hash (only required for security fixes)version: Valid version stringdescription: Change descriptionAll version references must be valid SemVer, or match the provided releasedVersions.
Estimated unpacked size across 65 packages.
2.5 MB+
Includes dependencies.
35 direct · 1 outdated
^2.8.4
2.9.1
^7.8.1
7.8.6
^4.0.1
4.0.1
^5.1.0
5.2.0
^3.0.1
3.0.1
^4.0.1
4.0.1
^5.0.1
5.0.1
4.0.1
4.0.1
4.0.1
4.0.1
4.2.0
4.0.2
4.0.1
5.0.1
4.0.1
4.0.1
5.0.0
5.0.0
5.1.1
7.0.1
4.1.1
5.0.1
4.0.2
4.0.1
5.0.1
5.0.1
3.0.1
5.0.1
4.0.1
4.0.1
3.0.1