vale-style-authoring-formats

Enforce Vale style guidelines across Markdown, HTML, AsciiDoc, and XML formats.

Updated May 4, 2026

Search Tags:#document formatting #document quality #style enforcement #Vale #markup languages

Ready to run

npx skills add https://github.com/ghalactic/vale-style --skill vale-style-authoring-formats

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: vale-style-authoring-formats
Source: https://github.com/ghalactic/vale-style/tree/main/.agents/skills/vale-style-authoring-formats
Command: npx skills add https://github.com/ghalactic/vale-style --skill vale-style-authoring-formats

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires asciidoctor, rst2html, xsltproc, mdx2vast, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill unit provides comprehensive support for various markup formats, making it easier to adhere to Vale's guidelines and improve document quality.

Core Features & Use Cases

Multi-Format Support: Handle Markdown, MDX, HTML, AsciiDoc, reStructuredText, Org, DITA, XML, code comments, and front matter formats.
Built-in and External Dependencies: Leverages both built-in and external tools like asciidoctor, rst2html, and xsltproc.
Comment-based Configuration: Allows for fine-grained control over Vale's behavior through inline comments in supported formats.
Front Matter Linting: Ensures that front matter in Markdown, AsciiDoc, reStructuredText, MDX, and Org files adheres to Vale's standards.
Code Comments Linting: Supports linting source code comments across multiple programming languages.

Quick Start

Run the 'vale-style-authoring-formats' skill to understand how to configure Vale for different document formats and apply specific styles or rules.

Frequently Asked Questions about vale-style-authoring-formats

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

FAQPage Schema

How do I enforce Vale style rules across multiple markup languages like Markdown and AsciiDoc?▼

To enforce Vale style rules across multiple markup languages, this Skill supports Markdown, MDX, HTML, AsciiDoc, and reStructuredText by leveraging external tools like asciidoctor and rst2html to process and lint documents.

Can I lint front matter in MDX files using Vale?▼

Yes, you can lint front matter in MDX files using Vale. This functionality ensures that front matter in Markdown, AsciiDoc, reStructuredText, MDX, and Org files adheres to configured Vale standards.

Does Vale style enforcement support linting code comments in source files?▼

Yes, Vale style enforcement supports linting source code comments across multiple programming languages, allowing you to maintain documentation quality and consistency directly within your codebase.

How do I configure Vale behavior inline without editing the main configuration file?▼

You can configure Vale behavior inline without editing the main configuration file by using comment-based configuration, which allows fine-grained control over Vale's behavior directly through inline comments in supported formats.

What external dependencies are needed to process AsciiDoc and XML files with Vale?▼

To process AsciiDoc and XML files with Vale, external dependencies like asciidoctor for AsciiDoc and xsltproc for XML are required, enabling Vale to parse and enforce styles on these specific formats.

Why is my reStructuredText document not linting correctly with Vale?▼

If your reStructuredText document is not linting correctly with Vale, ensure the external rst2html tool is properly installed and configured, as Vale relies on this dependency to process reStructuredText files.