Skip to content
This repository has been archived by the owner on May 12, 2024. It is now read-only.

Commit

Permalink
Update README.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Gaurav Nelson committed Aug 2, 2017
1 parent 4bb2fc2 commit 371cfa4
Showing 1 changed file with 28 additions and 27 deletions.
55 changes: 28 additions & 27 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
= asciidoc-link-check
Checks if all hyperlinks in an asciidoc file are alive(or dead).

(Uses most of the source code from https://github.com/tcort/markdown-link-check[markdown-link-check] module)
(Uses the source code from https://github.com/tcort/markdown-link-check[markdown-link-check] module)

== Installation
To add the module to your project, run:
== Local Installation
To install the command line tool, run:
[source, bash]
----
npm install --save asciidoc-link-check
npm install -g asciidoc-link-check
----

=== Usage
(Optional) Use the `-p` or `--progress` switch to view progress.

==== Check links for a local file
[source,bash]
----
asciidoc-link-check README.adoc --progress
----

==== Check links for an online file
[source,bash]
----
asciidoc-link-check https://github.com/gaurav-nelson/asciidoc-link-check/blob/master/README.adoc
----

==== Check links from standard input
[source,bash]
----
cat *.adoc | asciidoc-link-check -p
----

To install the command line tool globally, run:
=== Using in your node project
To add the module to your project, run:
[source, bash]
----
npm install -g asciidoc-link-check
npm install --save asciidoc-link-check
----

== API
Expand Down Expand Up @@ -43,24 +65,3 @@ asciidocLinkCheck('xref:https://www.google.com[Google]', function (err, results)
});
});
----

=== Command Line
(Optional) Use the `-p` or `--progress` switch to view progress.

==== Check links for a local file
[source,bash]
----
asciidoc-link-check README.adoc --progress
----

==== Check links for an online file
[source,bash]
----
asciidoc-link-check https://github.com/gaurav-nelson/asciidoc-link-check/blob/master/README.adoc
----

==== Check links from standard input
[source,bash]
----
cat *.adoc | asciidoc-link-check -p
----

0 comments on commit 371cfa4

Please sign in to comment.