From dita-tools
Validates AsciiDoc files for DITA conversion readiness using Vale linting with AsciiDocDITA rules. Reports warnings and errors in markdown table format. Useful when checking files before DITA conversion.
npx claudepluginhub redhat-documentation/redhat-docs-agent-tools --plugin dita-toolsThis skill is limited to using the following tools:
Validate AsciiDoc assemblies or modules for DITA conversion readiness by running Vale linting with AsciiDocDITA rules. Results are formatted as a markdown table with one issue per row.
Runs Vale with AsciiDocDITA rules on AsciiDoc files in Red Hat modular docs repos (repo-wide or assembly/topic scope via dita-validate-asciidoc) and fixes violations for 0 errors/warnings.
Runs Asciidoctor on AsciiDoc files to validate syntax, reports errors/warnings from /tmp logs, and suggests fixes for unclosed conditionals, admonitions, blocks.
Reviews AsciiDoc (.adoc) files for Red Hat modular documentation compliance: module types (concept, procedure, reference), assembly structure, anchor IDs with _{context}, context variables, and include directives.
Share bugs, ideas, or general feedback.
Validate AsciiDoc assemblies or modules for DITA conversion readiness by running Vale linting with AsciiDocDITA rules. Results are formatted as a markdown table with one issue per row.
This skill runs Vale with the AsciiDocDITA rule set to identify DITA compatibility issues in AsciiDoc files. For assemblies, it automatically discovers all included files using dita-includes. Only warnings and errors are reported (suggestions are excluded).
bash scripts/validate_asciidoc.sh <file.adoc> [options]
| Option | Description |
|---|---|
-l, --list-only | Only list files, don't run Vale |
-h, --help | Show help message |
# Validate an assembly and all includes (only existing files are processed)
bash scripts/validate_asciidoc.sh master.adoc
# List files that would be validated
bash scripts/validate_asciidoc.sh master.adoc --list-only
The script outputs Vale issues in line format:
file:line:column:severity:rule:message
Example output:
/path/to/modules/con-intro.adoc:12:5:warning:AsciiDocDITA.BlockTitle:Block titles are not supported
/path/to/modules/proc-install.adoc:8:1:error:AsciiDocDITA.HardLineBreak:Hard line breaks are not supported
/path/to/modules/ref-options.adoc:25:10:warning:AsciiDocDITA.EntityReference:Use Unicode instead of HTML entities
After running the script, format the output as a markdown table:
| File | Line | Severity | Rule | Message |
|---|---|---|---|---|
| modules/con-intro.adoc | 12 | warning | AsciiDocDITA.BlockTitle | Block titles are not supported |
| modules/proc-install.adoc | 8 | error | AsciiDocDITA.HardLineBreak | Hard line breaks are not supported |
| modules/ref-options.adoc | 25 | warning | AsciiDocDITA.EntityReference | Use Unicode instead of HTML entities |
Include a summary at the end:
Summary: 1 error, 2 warnings
dita-includes scriptvale sync to download the AsciiDocDITA package--minAlertLevel=warning on all filesThe script uses a hardcoded Vale configuration:
StylesPath = .vale/styles
MinAlertLevel = warning
Packages = https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
[*.adoc]
BasedOnStyles = AsciiDocDITA
dita-tools:dita-includes skill script must be availablescripts/
└── validate_asciidoc.sh # Bash script for DITA validation