asciidoc-aware-link-check
Test the links in your asciidoc files.
Last updated a month ago by jboxman .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install asciidoc-aware-link-check 
SYNC missed versions from official npm registry.

Why

I need to be able to validate external links that might be derived from attributes.

With this application, you can validate any link directive that references a URL with either an HTTP or HTTPS method.

Installation

To install the application, complete the following steps:

  1. git clone https://github.com/jboxman/asciidoc-aware-link-check.git
  2. cd asciidoc-aware-link-check
  3. npm install
  4. npm link

Eventually, I might try packaging this module and uploading it to the npm package repository.

Usage

To learn about supported options, enter the following command:

$ asciidoc-aware-link-check --help
Usage: asciidoc-aware-link-check [options] [assemblyFile]

Options:
  --no-progress  Show progress bar
  -q, --quiet    Display errors only
  --csv          Output in CSV format
  -n, --dry      Dry run
  --asciibinder  Support asciibinder style include directives
  -h, --help     output usage information

To validate links, enter the following command. Replace <assembly-file> with the file name that includes any include statements needed to successfully build your documentation.

$ asciidoc-aware-link-check <assembly-file>

To validate links for your entire documentation set, you might enter the following the command. Replace <assembly-dir> with the directory where you save your assembly files.

$ find <assembly-dir> -type f -name '*.adoc' | \
  xargs -L1 -I% -P1 asciidoc-aware-link-check %

Known issues

  • A HTTP/1.1 301 Moved Permanently is considered a broken link.

TODO

  • Finish tests

Credits

This work is based on the asciidoc-link-check module.

Current Tags

  • 1.0.0                                ...           latest (a month ago)

1 Versions

  • 1.0.0                                ...           a month ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 10
Dependencies (6)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |