skills.rest
Tirael
TiraelCOMMUNITY
Explore all skills by this author →
GitHub

markdownlint-workflow

Automate Markdown linting and style enforcement using .markdownlint.json.

Updated Feb 4, 2026
Search Tags:#automation#documentation#markdown#style#lint#ci
One-click install
npx skills add https://github.com/Tirael/cursor-template --skill markdownlint-workflow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdownlint-workflow
Source: https://github.com/Tirael/cursor-template/tree/main/.cursor/skills/markdownlint-workflow
Command: npx skills add https://github.com/Tirael/cursor-template --skill markdownlint-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes and enforces Markdown style and formatting across a repository by centralizing lint rules and automation.

Core Features & Use Cases

  • Canonical config: relies on a root .markdownlint.json to ensure consistent rules.
  • Multiple activation options: supports npm script (npm run lint:md) or direct linting via markdownlint-cli2.
  • Use Case: teams maintaining large docs and READMEs can automatically detect and fix common Markdown issues across many files.

Quick Start

Run npm run lint:md to lint all Markdown files in your repository and apply standard fixes.

Frequently Asked Questions about markdownlint-workflow

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

FAQPage Schema
How do I automate markdown style enforcement across a repository?▼

Automate markdown style enforcement by running npm run lint:md or npx markdownlint-cli2 against repository files, applying standardized formatting rules defined in a root .markdownlint.json configuration file to unify markdown quality.

What is the canonical config for markdown linting in CI workflows?▼

The canonical config for markdown linting is a root .markdownlint.json file that ensures consistent style rules across all Markdown files in the repository. It centralizes formatting standards so all lint commands reproduce identical results.

How do I lint all Markdown files in my repository using markdownlint-cli2?▼

Lint all Markdown files by executing npx markdownlint-cli2 or npm run lint:md. The tool targets repository Markdown files using the canonical .markdownlint.json config to detect and report formatting issues.

Do I need a SKILL.md file to run markdown linting automation?▼

Yes, markdown linting automation requires a SKILL.md file with frontmatter containing a name and description. This metadata is required for the automation to coordinate optional resources like scripts, references, and assets.

Can I use this markdown lint workflow for large documentation repositories?▼

Yes, this markdown lint workflow suits teams maintaining large documentation repositories and READMEs. It automatically detects and fixes common Markdown issues across many files using centralized lint rules.

What are the limitations of relying on a root .markdownlint.json config?▼

Relying on a root .markdownlint.json config limits linting to the standardized rules defined in that single file. It requires all Markdown files to conform to one canonical style and cannot apply per-directory rule overrides.

Related Skills

Explore More Software Engineering Skills→
mecolejrmecolejr

storyboard

Plan shot-by-shot storyboards for TikTok, Reels, YouTube Shorts, and UGC campaigns.

Community
Advanced
mahg-esmahg-es
3

static-site-generate

Generate static websites from Markdown into deployable HTML with CI workflows.

Official
Intermediate
mvillmowmvillmow
18

doc-validate-markdown

Validate Markdown formatting and style compliance with markdownlint.

Community
Intermediate
ekremmkasapekremmkasap

python-code-style

Enforce Python code style with ruff, mypy, and Google-style docstrings.

Community
Intermediate