Registry / testing / remark-preset-lint-mkdocs-material

remark-preset-lint-mkdocs-material

library0.7.0jsnpmunverified

This preset configures remark-lint with rules that enforce the markdown style guide for MkDocs Material. Version 0.7.0 is the latest stable release. It is maintained by the community and provides a curated set of lint rules consistent with MkDocs Material's documentation style, such as heading levels, lists, and code blocks. It ships TypeScript types. Development appears intermittent with no fixed release cadence.

testing devops

npm install remark-preset-lint-mkdocs-material

github ↗package ↗

INSTALL

IMPORT

SIG · REMARK-PRESET-LINT

remark-preset-lint-mkdocs-material

testingjavascriptv0.7.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import preset from 'remark-preset-lint-mkdocs-material'

✗ const preset = require('remark-preset-lint-mkdocs-material')

ESM-only since it ships TypeScript types. CommonJS require might fail.

preset

✓ import { preset } from 'remark-preset-lint-mkdocs-material'

Named export if available; double-check package exports.

remarkPresetLintMkdocsMaterial

✓ import remarkPresetLintMkdocsMaterial from 'remark-preset-lint-mkdocs-material'

✗ import { remarkPresetLintMkdocsMaterial } from 'remark-preset-lint-mkdocs-material'

Default export is likely the preset object, not named.

Shows how to install and configure the preset in a .remarkrc.js file, and also how to use it via CLI.

// Install dependencies: // npm install remark-cli remark-preset-lint-mkdocs-material // .remarkrc.js import preset from 'remark-preset-lint-mkdocs-material'; export default { plugins: [ preset ] }; // Or CLI usage: // npx remark . --use remark-preset-lint-mkdocs-material

Debug

Known issues

gotchaThe preset may include rules that conflict with other remark presets if used together.

fix

Use only one preset at a time, or carefully merge configurations.

affects: >=0.0.0

gotchaThe preset expects MkDocs Material flavored Markdown; may not be suitable for other documentation generators.

fix

Consider using generic remark-preset-lint-recommended for other environments.

affects: >=0.0.0

deprecatedSome lint rules may be deprecated in future versions of remark-lint.

fix

Stay updated with remark-lint changelog and update preset rules accordingly.

affects: >=0.6.0

Errors

Common errors & fixes

Cannot find module 'remark-preset-lint-mkdocs-material'

Package not installed or not in node_modules.

fix

Run `npm install remark-preset-lint-mkdocs-material`.

Unexpected token 'export'

Using CommonJS require with an ESM-only package.

fix

Use import syntax and ensure you are in an ESM context (e.g., .mjs file or "type": "module" in package.json).

Unable to load preset 'remark-preset-lint-mkdocs-material'

The preset is not in the plugin list correctly.

fix

Check .remarkrc.js or .remarkrc configuration: plugin should be either string or object with options.

Upgrade

Version history

0.7.0latest on npm

Audit

Dependencies

remark-clioptionalRequired to run remark-lint presets from the command line

remark-lintrequiredCore linting engine that this preset configures

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/dup4/remark-preset-lint ↗

packagehttps://www.npmjs.com/package/remark-preset-lint-mkdocs-material ↗