Test the links in your Asciidoc files.
npm install @jboxman/asciidoc-aware-link-checkWhy
====
I need to be able to validate external links that might be derived from attributes.
With this application, you can validate any link directive that references a URL with either an HTTP or HTTPS method.
Installation
====
To install the application, complete the following steps:
1. npm i -g @jboxman/asciidoc-aware-link-check
Usage
====
To learn about supported options, enter the following command:
``
$ asciidoc-aware-link-check --help
Usage: asciidoc-aware-link-check [options]
Options:
-a, --attributes [attributes...] Optional: Attributes such as "product-version=1".
--csv Output to stdout in CSV format. Outputs BROKEN_LINK,MODULE,LINE_NUM. This option
implies --no-progress and --quiet.
-n, --dry Dry run.
--no-progress Hide progress bar.
-q, --quiet Display errors only.
--stdin Read file list from stdin instead of a _topic_map.yml file. (default: false)
--topic
-h, --help display help for command
`
To validate links, enter the following command. Replace with the file name that includes any include statements needed to successfully build your documentation.
``
$ echo
To validate links for your entire documentation set, you might enter the following the command. Replace with the directory where you save your assembly files.
``
$ find
Known issues
====
* A HTTP/1.1 301 Moved Permanently` is considered a broken link.
* Any links within a listing block are ignored.
TODO
====
* Finish tests
Credits
====
This work is based on the asciidoc-link-check module.