Asciidoc-link-checker
Tool to check each link of each asciidoc inside a wiki of a gitHub repository
How to use
-
Clone this repository into a local folder on your computer or install the tool globally:
npm install -g @oasp/asciidoc-link-checker
-
Open the console and move to that folder.
-
Install the dependencies:
npm install
-
(OPTIONAL) In order to make your own asciidoc-link-checker releases you need to install globally
np
:npm install -g np
-
Clone the wiki you want to check links:
git clone https://github.com/my-repository/my-repository.wiki.git
-
Start the checkout:
$ linkchecker ./my-repository.wiki/
The tool will check each link of each asciidoc inside the wiki searching those links that are wrong
Output
When the check is done, you will see on your console the links that didn't work and an exit code
If all links are correct you will see: 'Done: All links are correct'
Otherwise you will see: 'Done: Some link failed'