markdown-conventions

Enforce Markdown formatting and linting conventions using markdownlint, alex, and woke.

2|Updated Jan 7, 2026

Search Tags:#linting #markdown #formatting #style guide #documenting

Ready to run

npx skills add https://github.com/Integralist/agent-skills --skill markdown-conventions-integralist

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-conventions
Source: https://github.com/Integralist/agent-skills/tree/main/.agents/skills/markdown-conventions
Command: npx skills add https://github.com/Integralist/agent-skills --skill markdown-conventions-integralist

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires mdformat, mdformat-gfm, mdformat-frontmatter, markdownlint, alex, woke, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures consistent and readable Markdown formatting across all your documentation, eliminating inconsistencies and improving the user experience.

Core Features & Use Cases

Formatting Standards: Enforces a set of Markdown formatting standards for wrapping, code blocks, and callouts.
Code Block Guidelines: Provides best practices for using code blocks with language identifiers.
Callout Usage: Offers guidance on the proper use of callouts for highlighting important information.
Linting Tools: Integrates with markdownlint, alex, and woke to check for style, inclusivity, and quality.

Quick Start

Run the mdformat tool to automatically format your Markdown file and apply the defined conventions.

Frequently Asked Questions about markdown-conventions

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

FAQPage Schema

How do I enforce consistent Markdown formatting and linting across my documentation?▼

Markdown formatting and linting consistency is enforced by applying style rules for wrapping, code blocks, and callouts, then running automated checks to catch violations. This eliminates inconsistencies and improves documentation readability.

What's the best way to check Markdown documentation for inclusivity issues?▼

Checking Markdown for inclusivity issues is handled by integrating tools like alex and woke to scan content. These tools identify inconsiderate or biased language during the linting process, ensuring documentation remains welcoming and inclusive.

How do I automatically format Markdown files using mdformat?▼

Automatically formatting Markdown files with mdformat requires running the tool against your target files. The tool applies defined conventions for wrapping and structural elements, instantly standardizing your documentation without manual edits.

Does this Markdown style guide support GitHub Flavored Markdown and frontmatter?▼

Yes, the Markdown style guide supports GitHub Flavored Markdown and frontmatter through the mdformat-gfm and mdformat-frontmatter dependencies. This ensures proper formatting and linting for advanced syntax and metadata blocks.

When do I need to use specific language identifiers in Markdown code blocks?▼

Specific language identifiers in Markdown code blocks are needed whenever you include code snippets to ensure proper syntax highlighting and formatting. The linting guidelines enforce this best practice to maintain clarity and consistency in documentation.

What are the limitations of using markdownlint for documentation quality checks?▼

Markdownlint is limited to checking structural style and syntax rules, so it cannot detect inclusivity issues. To address this, the Skill complements markdownlint with alex and woke to comprehensively scan for inconsiderate language.