UNPKG

@capgemtest/asciidoc-link-checker

Version:
31 lines (20 loc) 831 B
# Asciidoc-link-checker Tool to check each link of each asciidoc inside a wiki of a gitHub repository # How to use 1. Clone this repository into a local folder on your computer 2. Open the console and move to that folder 3. Install ts-node `npm install ts-node` 4. Install the dependencies: `nmp install` 5. Clone the wiki you want to check links: `git clone https://github.com/my-repository/my-repository.wiki.git` 6. Start the checkout: `$ ts-node ./src/index.ts ./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: 'exit code 0' Otherwise you will see: 'exit code 1'