AsciiDocDoctor

Utility tool for AsciiDoc files.

How to run

The command will fun all .adoc files recursively starting from where you run it.

Run the following and it will look recursively for .md files starting from the directory you are in.

$ npx asciidocdoctor

Or install it globally:

$ npm install -g asciidocdoctor

Now you can run it like this:

$ asciidocdoctor

Flags

| Flags | Description | |------------------|-------------------------------------------------------------------------------------------------------| | --all | Run all checks. Defaults to true of no other options have been given. | | --validate-links | Validates that the links defined in the AsciiDoc file exist on the file system. | | --validate-tables | Validates that tables are defined with valid syntax: The right amount of columns according to the header. |

Validating tables

The --validate-tables will validate on the following:

• That the table has a header.
• That the table has the same amount of columns as the header if present.
• That the rows have a consistent amount of columns.
• That the table has a footer.