markdownlint-writer

name	markdownlint-writer
description	Agent Skill for finalizing markdownlint-compliant Markdown. Use before git commit, when the user indicates the task is done, when you complete a meaningful phase of work, or when the user explicitly requests Markdown cleanup.

Markdownlint Writer

Workflow

1. Identify the Markdown file(s) created or edited during the current task or phase of work.
2. Do not run formatting or lint autofixes after every small Markdown edit. Keep drafting and iterative edits flexible until a finalization checkpoint.
3. Treat the following as finalization checkpoints:
   • Before git commit
   • When the user indicates the task is done
   • When you complete a meaningful phase of work
   • When the user explicitly asks for Markdown formatting or lint cleanup
4. At a finalization checkpoint, run markdownlint-cli2 --fix on the modified Markdown file(s).
5. Use this skill's bundled config at references/.markdownlint-cli2.yaml, resolved relative to SKILL.md.
6. Use these tools for final cleanup before relying on LLM-written edits for style-only fixes.
7. Learn from formatter and linter feedback to improve your Markdown writing habits over time.

Format And Lint Commands

At a finalization checkpoint, run the formatter and linter on the exact Markdown files you changed, with the bundled config file:

markdownlint-cli2 --config "/path/to/this-skill/references/.markdownlint-cli2.yaml" --fix "README.md" "docs/guide.md"

User Convention on Markdown format

1. Avoid extensive use of bolding.
2. Avoid line wrapping.
3. Do not use bolding as a header. Use proper Markdown headings instead.
4. Usually a code block is fenced inside a triple backtick. But for code blocks of Markdown, use 4 backticks instead of 3.