• Home
• nu.validator
• validator
• 17.0.1
• source code
• cli-help

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

nu.validator.localentities.files.cli-help Maven / Gradle / Ivy

# The Nu Html Checker (v.Nu) [![Chat room][1]][2] [![Download latest][3]][4]

   [1]: https://goo.gl/1kHqwI
   [2]: https://gitter.im/validator/validator
   [3]: https://goo.gl/3PC2Qn
   [4]: https://github.com/validator/validator/releases/latest

The Nu Html Checker (v.Nu) is the backend of [checker.html5.org][5],
[html5.validator.nu][6], and [validator.w3.org/nu][7]. Its [source code is
available][8], as are [instructions on how to build, test, and run the code][9].
It is released as two packages:

   [5]: https://checker.html5.org/
   [6]: https://html5.validator.nu
   [7]: http://validator.w3.org/nu/
   [8]: https://github.com/validator/validator
   [9]: https://validator.github.io/validator/#build-instructions

  * `vnu.jar` is a portable standalone version for [batch-checking documents
  from the command line][10] and from other scripts/apps, or for [deploying the
  checker as a self-contained service][11]

  * `vnu.war` is for [deploying the checker service through a servlet container
  such as Tomcat][12]

   [10]: https://validator.github.io/validator/#usage
   [11]: https://validator.github.io/validator/#standalone
   [12]: https://validator.github.io/validator/#servlet

**Note:** The _vnu.jar_ and _vnu.war_ packages require a Java 8 environment;
they won’t run in Java 7 or older environment.

You can [get the latest release][13] or run [`npm install vnu-jar`][14], [`pip
install html5validator`][15] or [`brew install vnu`][16], and see the **Usage**
and **Web-based checking** sections below. Or automate your HTML checking with a
frontend such as:

   [13]: https://github.com/validator/validator/releases/latest
   [14]: https://www.npmjs.com/package/vnu-jar
   [15]: https://github.com/svenkreiss/html5validator
   [16]: https://libraries.io/homebrew/vnu

  * [Grunt plugin for HTML validation][17] or [Gulp plugin for HTML
  validation][18]

  * [html5validator `pip` package][19] (for HTML checking integration in Travis
  CI, CircleCI, CodeShip, [Jekyll][20], [Pelican][21] etc.)

  * [LMVTFY: Let Me Validate That For You][22] (auto-check HTML of
  JSFiddle/JSBin etc. links in github issue comments)

   [17]: https://github.com/jzaefferer/grunt-html
   [18]: https://github.com/watilde/gulp-html
   [19]: https://github.com/svenkreiss/html5validator
   [20]: http://jekyllrb.com/
   [21]: http://blog.getpelican.com/
   [22]: https://github.com/cvrebert/lmvtfy/

## Usage

Use the `vnu.jar` HTML checker as an executable for command-line checking of
documents by invoking it like this:

      java -jar vnu.jar [--errors-only] [--no-stream]
           [--format gnu|xml|json|text] [--help] [--html] [--no-langdetect]
           [--skip-non-html] [--verbose] [--version] FILES

**Note:** In these instructions, replace _"~/vnu.jar"_ with the actual path to
the file on your system.

To check one or more documents from the command line:

      java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...

**Note:** If you get a `StackOverflowError` error when using the vnu.jar file,
try adjusting the thread stack size by providing the `-Xss` option to java:

      java -Xss512k -jar ~/vnu.jar FILE.html...

To check all documents in a particular directory:

      java -jar ~/vnu.jar some-directory-name/

To check all documents in a particular directory, skipping any documents whose
names don’t end with the extensions `.html`, `.htm`, `.xhtml`, or `.xht`:

      java -jar ~/vnu.jar --skip-non-html some-directory-name/

To check a Web document:

      java -jar ~/vnu.jar _URL_

      example: java -jar ~/vnu.jar http://example.com/foo

To check standard input:

      java -jar ~/vnu.jar -

      example: echo '