{"id":26297,"library":"remark-preset-lint-mkdocs-material","title":"remark preset to lint Markdown for MkDocs Material","description":"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.","status":"active","version":"0.7.0","language":"javascript","source_language":"en","source_url":"https://github.com/dup4/remark-preset-lint","tags":["javascript","remark","remark-preset","preset","markdown","style","guide","mkdocs","material","typescript"],"install":[{"cmd":"npm install remark-preset-lint-mkdocs-material","lang":"bash","label":"npm"},{"cmd":"yarn add remark-preset-lint-mkdocs-material","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-preset-lint-mkdocs-material","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Required to run remark-lint presets from the command line","package":"remark-cli","optional":true},{"reason":"Core linting engine that this preset configures","package":"remark-lint","optional":false}],"imports":[{"note":"ESM-only since it ships TypeScript types. CommonJS require might fail.","wrong":"const preset = require('remark-preset-lint-mkdocs-material')","symbol":"default","correct":"import preset from 'remark-preset-lint-mkdocs-material'"},{"note":"Named export if available; double-check package exports.","wrong":null,"symbol":"preset","correct":"import { preset } from 'remark-preset-lint-mkdocs-material'"},{"note":"Default export is likely the preset object, not named.","wrong":"import { remarkPresetLintMkdocsMaterial } from 'remark-preset-lint-mkdocs-material'","symbol":"remarkPresetLintMkdocsMaterial","correct":"import remarkPresetLintMkdocsMaterial from 'remark-preset-lint-mkdocs-material'"}],"quickstart":{"code":"// Install dependencies:\n// npm install remark-cli remark-preset-lint-mkdocs-material\n\n// .remarkrc.js\nimport preset from 'remark-preset-lint-mkdocs-material';\nexport default {\n  plugins: [\n    preset\n  ]\n};\n\n// Or CLI usage:\n// npx remark . --use remark-preset-lint-mkdocs-material","lang":"typescript","description":"Shows how to install and configure the preset in a .remarkrc.js file, and also how to use it via CLI."},"warnings":[{"fix":"Use only one preset at a time, or carefully merge configurations.","message":"The preset may include rules that conflict with other remark presets if used together.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Consider using generic remark-preset-lint-recommended for other environments.","message":"The preset expects MkDocs Material flavored Markdown; may not be suitable for other documentation generators.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Stay updated with remark-lint changelog and update preset rules accordingly.","message":"Some lint rules may be deprecated in future versions of remark-lint.","severity":"deprecated","affected_versions":">=0.6.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `npm install remark-preset-lint-mkdocs-material`.","cause":"Package not installed or not in node_modules.","error":"Cannot find module 'remark-preset-lint-mkdocs-material'"},{"fix":"Use import syntax and ensure you are in an ESM context (e.g., .mjs file or \"type\": \"module\" in package.json).","cause":"Using CommonJS require with an ESM-only package.","error":"Unexpected token 'export'"},{"fix":"Check .remarkrc.js or .remarkrc configuration: plugin should be either string or object with options.","cause":"The preset is not in the plugin list correctly.","error":"Unable to load preset 'remark-preset-lint-mkdocs-material'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}