Skip to content

Commit d91eabc

Browse files
Further refinements to the readme.
1 parent fd7b476 commit d91eabc

File tree

2 files changed

+39
-32
lines changed

2 files changed

+39
-32
lines changed

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
11
# The Nu Markup Checker (v.Nu) [![Build Status](http://goo.gl/b6xEQs)](http://goo.gl/ehNisw)
22

3-
The Nu Markup Checker (v.Nu) is a name for the backend behind
3+
The Nu Markup Checker (v.Nu) is a name for the backend of
44
[http://html5.validator.nu][1], [http://validator.w3.org/nu/][2], and the HTML5
55
facet of the legacy [W3C Validator][3]. Its source code is available from [a set
6-
of repositories hosted at github][4], as is `vnu.jar`, a portable standalone
7-
version for either batch-checking of HTML documents directly from the command
8-
line and from other scripts/apps, or for use as a simple standalone HTTP server
9-
that provides a service for browser-based checking of HTML documents over the
10-
Web—similar to [http://validator.w3.org/nu/][2].
6+
of repositories hosted at github][4]. The checker is released as two separate
7+
packages:
118

129
[1]: http://html5.validator.nu
1310
[2]: http://validator.w3.org/nu/
1411
[3]: http://validator.w3.org
1512
[4]: https://github.com/validator/
1613

17-
To use the Nu Markup Checker on your own, [get the latest release][5] and see
14+
* `vnu.jar` is a portable standalone version for either batch-checking of HTML
15+
documents directly from the command line and from other scripts/apps or for
16+
[deploying the checker as a simple standalone HTTP service][5]
17+
18+
* `vnu.war` is for [deploying the checker as an HTTP service through a servlet
19+
container such as Tomcat][6]
20+
21+
[5]: http://validator.github.io/service.html#standalone
22+
[6]: http://validator.github.io/service.html#servlet
23+
24+
To use the Nu Markup Checker on your own, [get the latest release][7] and see
1825
the **Usage** instructions below— or alternatively, consider automating your
1926
HTML checking with a frontend such as:
2027

21-
[5]: https://github.com/validator/validator.github.io/releases/latest
28+
[7]: https://github.com/validator/validator.github.io/releases/latest
2229

23-
* [Grunt plugin for HTML validation][6]
30+
* [Grunt plugin for HTML validation][8]
2431

25-
* [HTML5 Validator Integration for Travis CI][7] (auto-check documents pushed
32+
* [HTML5 Validator Integration for Travis CI][9] (auto-check documents pushed
2633
to a github repo)
2734

28-
* [LMVTFY: Let Me Validate That For You][8] (auto-check HTML of JSFiddle/JSBin
29-
etc. links in github issue comments)
35+
* [LMVTFY: Let Me Validate That For You][10] (auto-check HTML of
36+
JSFiddle/JSBin etc. links in github issue comments)
3037

31-
[6]: https://github.com/jzaefferer/grunt-html
32-
[7]: https://github.com/svenkreiss/html5validator
33-
[8]: https://github.com/cvrebert/lmvtfy/
38+
[8]: https://github.com/jzaefferer/grunt-html
39+
[9]: https://github.com/svenkreiss/html5validator
40+
[10]: https://github.com/cvrebert/lmvtfy/
3441

3542
## Usage
3643

@@ -90,9 +97,9 @@ executable provides the following options:
9097
possible values: "gnu", "xml", "json", "text"
9198

9299
see also:
93-
[http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out][9]
100+
[http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out][11]
94101

95-
[9]: http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out
102+
[11]: http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out
96103

97104
#### --help
98105

@@ -124,9 +131,8 @@ executable provides the following options:
124131

125132
Shows the vnu.jar version number.
126133

127-
For details on how to provide browser-based checking of documents over the Web
128-
using either the `vnu.jar` package or an alternative `vnu.war` package that’s
129-
also available, see [Web-based checking with vnu.war or vnu.jar][10].
134+
To provide browser-based checking of documents over the Web, see [Web-based
135+
checking with vnu.war or vnu.jar][12].
130136

131-
[10]: http://validator.github.io/service.html
137+
[12]: http://validator.github.io/service.html
132138

index.html

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,23 @@
55
<h1>The Nu Markup Checker (v.Nu)</h1>
66

77
<p>
8-
The Nu Markup Checker (v.Nu) is a name for the backend behind
8+
The Nu Markup Checker (v.Nu) is a name for the backend of
99
<a href="http://html5.validator.nu">http://html5.validator.nu</a>,
1010
<a href="http://validator.w3.org/nu/">http://validator.w3.org/nu/</a>,
1111
and the HTML5 facet of the legacy
1212
<a href="http://validator.w3.org">W3C Validator</a>.
1313

1414
Its source code is available from
15-
<a href="https://github.com/validator/">a set of repositories hosted at github</a>,
16-
as is <code>vnu.jar</code>, a portable standalone version for either
17-
batch-checking of HTML documents directly from the command line and from
18-
other scripts/apps, or for use as a simple standalone HTTP server that
19-
provides a service for browser-based checking of HTML documents over the
20-
Web—similar to
21-
<a href="http://validator.w3.org/nu/">http://validator.w3.org/nu/</a>.
15+
<a href="https://github.com/validator/">a set of repositories hosted at github</a>.
16+
The checker is released as two separate packages:
17+
<ul>
18+
<li><code>vnu.jar</code> is a portable standalone version for either
19+
<a href="#usage">batch-checking of HTML documents directly from the command line</a>
20+
and from other scripts/apps or for
21+
<a href="http://validator.github.io/service.html#standalone">deploying the checker as a simple standalone HTTP service</a>
22+
<li><code>vnu.war</code> is for
23+
<a href="http://validator.github.io/service.html#servlet">deploying the checker as an HTTP service through a servlet container such as Tomcat</a>
24+
</ul>
2225

2326
<p>
2427
To use the Nu Markup Checker on your own,
@@ -150,8 +153,6 @@ <h4 id="version">--version</h4>
150153
</section>
151154
</div>
152155

153-
<p>For details on how to provide browser-based checking of documents over
154-
the Web using either the <code>vnu.jar</code> package or an alternative
155-
<code>vnu.war</code> package that’s also available, see
156+
<p>To provide browser-based checking of documents over the Web, see
156157
<a href="http://validator.github.io/service.html">Web-based checking with vnu.war or vnu.jar</a>.
157158
</p>

0 commit comments

Comments
 (0)