Git Product home page Git Product logo

asciidoc-link-checker's Introduction

Asciidoc-link-checker

build status

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'

asciidoc-link-checker's People

Contributors

jorge-dacal avatar maybeec avatar salfuve avatar sjimenez77 avatar sujith-mn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.