write-markdown

Apply GitHub Flavored Markdown style conventions to Markdown files.

2|1|Updated Jan 14, 2026

Search Tags:#linting #documentation #markdown #formatting #style guide #content creation

Ready to run

npx skills add https://github.com/cboone/cboone-cc-plugins --skill write-markdown

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-markdown
Source: https://github.com/cboone/cboone-cc-plugins/tree/main/plugins/write-markdown/skills/write-markdown
Command: npx skills add https://github.com/cboone/cboone-cc-plugins --skill write-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures consistency and adherence to best practices when creating or editing Markdown files, improving readability and maintainability.

Core Features & Use Cases

Style Enforcement: Applies predefined Markdown conventions for structure, headings, links, lists, and code blocks.
Validation Guidance: Provides instructions on how to validate Markdown using linters like markdownlint-cli2.
Use Case: When contributing to a project's documentation, use this Skill to automatically format your .md files according to the established project style guide, preventing style inconsistencies.

Quick Start

Use the write-markdown skill to format the content of the file 'README.md'.

Frequently Asked Questions about write-markdown

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

FAQPage Schema

How do I enforce Markdown style conventions in my documentation files?▼

You can enforce Markdown style conventions by applying rules for document structure, headings, links, lists, and code blocks. This ensures consistency and adherence to best practices, improving readability and maintainability for new or existing Markdown files.

What is the best way to format a README file according to a project style guide?▼

The best way to format a README file is to apply GitHub Flavored Markdown conventions automatically. This enforces specific document structures, heading formats, link conventions, list styles, and whitespace rules to prevent style inconsistencies across project documentation.

How do I validate Markdown files for style compliance using markdownlint-cli2?▼

To validate Markdown files for style compliance, you can use linters like markdownlint-cli2. This validation checks your files against established style conventions, ensuring that document structure, code block syntax, and whitespace rules meet the required standards.

Can I use this Markdown formatting approach for existing files or only new content?▼

You can apply Markdown formatting conventions to both new and existing files. It targets GitHub Flavored Markdown rules to enforce structure, heading formats, and list styles, improving readability and maintainability across all your documentation content.

What specific Markdown formatting rules are enforced during style validation?▼

Markdown style validation enforces rules for document structure, heading formats, link conventions, list styles, code block syntax, and whitespace. These conventions target GitHub Flavored Markdown standards to maintain consistency across documentation files.