skills.rest
brainbrewlabs
brainbrewlabsOFFICIAL
Explore all skills by this author →
GitHub

formatting

Format Markdown, reStructuredText, and AsciiDoc documentation files for publication.

7|3|Updated Mar 17, 2026
Search Tags:#linting#documentation#markdown#formatting#prettier#link-check
One-click install
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill formatting
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: formatting
Source: https://github.com/brainbrewlabs/brainbrew-devkit/tree/main/plugin/config/templates/docs/skills/formatting
Command: npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill formatting

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Format and clean documentation files to meet publication standards by applying consistent style rules, fixing common Markdown issues, and validating internal links so docs are readable and publishable.

Core Features & Use Cases

  • Detect documentation format (Markdown, reStructuredText, AsciiDoc) and note existing style conventions.
  • Run linters such as markdownlint to identify issues and use prettier to auto-fix formatting where available.
  • Enforce consistent heading hierarchy, ensure code blocks include language tags, normalize list markers, remove trailing whitespace, and guarantee files end with a newline.
  • Validate internal links and correct broken references with either automated checks or manual edits.
  • Use Case: Polish generated documentation after an automated doc-generation step to ensure consistent style and link integrity before publishing.

Quick Start

Format the docs directory to enforce consistent headings, add code fence languages, normalize list markers and whitespace, auto-fix where possible, and validate internal links.

Frequently Asked Questions about formatting

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

FAQPage Schema
How do I format Markdown files for publication and fix heading hierarchy?▼

Format Markdown files for publication by enforcing heading hierarchy, normalizing whitespace, and ensuring code blocks include language tags. The Skill detects existing conventions and runs markdownlint and prettier to auto-fix these issues.

What is the best way to validate internal links in Markdown documentation before publishing?▼

Validate internal links in Markdown documentation using markdown-link-check to identify and correct broken references. When automated tooling is unavailable, the Skill falls back to manual Read/Edit verification to ensure link validity.

Does this formatting approach work with reStructuredText and AsciiDoc files?▼

Yes, this formatting approach works with reStructuredText and AsciiDoc files. The Skill detects the documentation format and applies style conventions to enforce consistent structure and link validity across these formats.

How do I ensure code fence language tags and consistent list markers in my docs?▼

Ensure code fence language tags and consistent list markers by running automated formatting tools. The Skill applies prettier to normalize list markers and verifies that all code blocks include proper language tags for publication readiness.

What happens if markdownlint or prettier are not available in my repository?▼

If markdownlint or prettier are not available, the Skill falls back to manual Read/Edit verification. This ensures formatting rules like trailing whitespace removal and newline terminators are still applied to your documentation files.

Related Skills

Explore More Content & Communication Skills→
seb1nseb1n
147

technical-writing

Generate technical documentation in Markdown, reStructuredText, and AsciiDoc formats.

Community
Intermediate
acartineacartine
1

documentation

Generate user-focused documentation that matches project conventions and supports TOC integration.

Community
Intermediate
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
jey3dayojey3dayo
6

docs-write

Enforce consistent Markdown formatting and linting with Prettier and markdownlint-cli2.

Community
Intermediate