formatting

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.