skills.rest
jwvdvuurst
jwvdvuurstCOMMUNITY
Explore all skills by this author →
GitHub

markdownlint-integration

Integrate markdownlint into CLI, programmatic, CI/CD, and editor workflows.

Updated Dec 26, 2025
Search Tags:#automation#ci/cd#linting#markdown#pre-commit#markdownlint#editor integration
One-click install
npx skills add https://github.com/jwvdvuurst/CalculatorCollection --skill markdownlint-integration-jwvdvuurst
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdownlint-integration
Source: https://github.com/jwvdvuurst/CalculatorCollection/tree/main/skills/markdownlint-integration
Command: npx skills add https://github.com/jwvdvuurst/CalculatorCollection --skill markdownlint-integration-jwvdvuurst

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint, markdownlint-cli.

What problem does it solve? Maintaining consistent markdown quality across a project requires manual review, which is error-prone and does not scale. This Skill provides complete guidance for embedding markdownlint into every stage of a development workflow so markdown violations are caught and fixed automatically. ## Core Features & Use Cases - CLI and Programmatic API: Run markdownlint from the command line with glob patterns, ignore rules, and auto-fix, or call the callback, promise, and sync JavaScript APIs to lint files and strings in Node.js. - CI/CD and Pre-commit Automation: Ready-to-use configurations for GitHub Actions, GitLab CI, CircleCI, Jenkins, Azure Pipelines, Husky, lint-staged, and the pre-commit framework. - Editor and Monorepo Integration: Setup instructions for VS Code, Vim/Neovim, Sublime Text, and Atom, plus Docker, Lerna, and Turborepo workspace configurations. - Use Case: A team wants to enforce documentation standards on every pull request. Use this Skill to add a GitHub Actions workflow that runs markdownlint, plus a Husky pre-commit hook that auto-fixes violations before code reaches the repository. ## Quick Start Set up markdownlint in my project with a pre-commit hook and a GitHub Actions workflow that lints all markdown files.

Frequently Asked Questions about markdownlint-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run markdownlint from the command line?▼

Install markdownlint-cli via npm, then run markdownlint with a glob pattern like '**/*.md' to lint all markdown files. Use the -f flag to auto-fix violations, --ignore to exclude directories like node_modules, and -c to specify a configuration file.

How do I use the markdownlint programmatic API in Node.js?▼

Import the lint function from markdownlint, markdownlint/promise, or markdownlint/sync depending on your preferred style. Pass an options object with files or strings and a config, then process the results object keyed by filename.

How do I add markdownlint to GitHub Actions?▼

Create a workflow that checks out the code, sets up Node.js, installs dependencies, and runs npx markdownlint with your glob pattern. Alternatively, use the DavidAnson/markdownlint-cli2-action for a simpler configuration with a paths input.

Can markdownlint automatically fix violations?▼

Yes, markdownlint-cli supports the -f flag to auto-fix fixable violations in place. Programmatically, use the applyFixes function with lint results to apply fixes to file content before writing it back.

How do I set up a markdownlint pre-commit hook?▼

Use Husky to create a pre-commit hook that runs an npm script invoking markdownlint, or combine it with lint-staged so only staged markdown files are linted and fixed. The pre-commit framework also offers markdownlint-cli and markdownlint-cli2 hooks.

Why is markdownlint linting my node_modules directory?▼

This happens when ignore patterns are missing from the CLI invocation. Add --ignore node_modules to the command, or define ignores in a .markdownlint-cli.json configuration file to exclude dependencies and build output permanently.

Related Skills

Explore More Software Engineering Skills→
pantheon-orgpantheon-org
9

markdown-authoring

Author lint-compliant Markdown documentation with deterministic structure and CI integration.

Official
Intermediate
nodefonynodefony

nodefony-documentation

Write, validate, and publish Nodefony documentation with lint gates and site generation.

Official
Advanced
smart-swimmingpoolsmart-swimmingpool
25

cpp-code-quality

Run clang-format, cpplint, editorconfig-checker, markdownlint, yamllint, and platformio check on C++ projects.

Official
Intermediate
HermeticOrmusHermeticOrmus

Style Guide Patterns

Create and enforce technical style guides with Vale automation.

Community
Intermediate