https://github.com/devonfw/asciidoc-link-checker

Tool to check links in AsciiDoc files
https://github.com/devonfw/asciidoc-link-checker

Last synced: about 1 year ago
JSON representation

Tool to check links in AsciiDoc files

• Host: GitHub
• URL: https://github.com/devonfw/asciidoc-link-checker
• Owner: devonfw
• License: apache-2.0
• Created: 2017-07-07T08:15:15.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T02:26:20.000Z (about 3 years ago)
• Last Synced: 2025-03-28T02:04:42.000Z (about 1 year ago)
• Language: TypeScript
• Size: 476 KB
• Stars: 5
• Watchers: 23
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Asciidoc-link-checker

[![build status](https://travis-ci.org/oasp/asciidoc-link-checker.svg?branch=master)](https://travis-ci.org/oasp/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 or install the tool globally:

    `npm install -g @oasp/asciidoc-link-checker`

2.  Open the console and move to that folder.

3.  Install the dependencies:

    `npm install`

4.  (OPTIONAL) In order to make your own **asciidoc-link-checker** releases you need to install globally `np`:

    `npm install -g np`

5.  Clone the wiki you want to check links:

    `git clone https://github.com/my-repository/my-repository.wiki.git`

6.  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'