#343 #314 #318 Add links to rendered manuals

for README files on GitHub. And fix some typos.

README.adoc

@@ -6,6 +6,10 @@ ifndef::xrefToCli[:xrefToCli: htmlSanityCheck-cli/README.adoc]
 ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/README.adoc]
 ifndef::xrefToMavenPlugin[:xrefToMavenPlugin: htmlSanityCheck-maven-plugin/README.adoc]
 
+ifdef::env-github[]
+TIP: Use the https://hsc.aim42.org/manual/10_manual.html[HSC Site] for a nicely rendered version of this manual.
+endif::env-github[]
+
 [.lead]
 ====
 https://hsc.aim42.org[HTML Sanity Check] (HSC) provides some basic sanity checking on HTML files.
@@ -58,7 +62,7 @@ Depending on your <<sec:usage>> find respective
 [cols="1,1",width="50%"]
 |===
 | The overall goal is to create neat and clear reports,
-showing eventual errors within HTML files - as shown in the adjoining figure.
+showing eventual errors within HTML files — as shown in the adjoining figure.
 | image:sample-hsc-report.jpg[width="200",link="{imagesdir}/sample-hsc-report.jpg"
 (click on thumbnail for details)]
 |===
@@ -133,9 +137,9 @@ Please see our https://hsc.aim42.org/arc42/About-This-Docu.html[software archite
 
 This tiny piece rests on incredible groundwork:
 
-* https://jsoup.org[Jsoup HTML parser] and analysis toolkit - robust and easy-to-use.
+* https://jsoup.org[Jsoup HTML parser] and analysis toolkit — robust and easy-to-use.
 
-* IntelliJ IDEA - my (Gernot) best (programming) friend.
+* IntelliJ IDEA — my (Gernot) best (programming) friend.
 
 * Of course, Groovy, Gradle, JUnit and Spock framework.
 
@@ -154,7 +158,7 @@ https://github.com/rrice/java-string-similarity[Ralph Rice].
 
 == Similar Projects
 
-* Once upon a time the https://github.com/rackerlabs/[rackerlabs] hosted `gradle-linkchecker-plugin` which was an (open source) Gradle plugin.
+* Once upon a time the https://github.com/rackerlabs/[racketeers] hosted `gradle-linkchecker-plugin` which was an (open source) Gradle plugin.
  It validated that all links in a local HTML file tree go out to other existing local files or remote web locations, creating a simple text file report.
 +
 CAUTION: However, as of 2024-08-14 they have deleted the repository (there seems to be a fork in https://github.com/leonard84/gradle-linkchecker-plugin[]).

htmlSanityCheck-cli/README.adoc

@@ -9,13 +9,17 @@ ifndef::xrefToManual[:xrefToManual: ../README.adoc]
 :gradleProperties: link:../gradle.properties[]
 ifdef::jbake-type[:gradleProperties: {project-url}/blob/develop/gradle.properties[]]
 
+ifdef::env-github[]
+TIP: Use the https://hsc.aim42.org/manual/20_cli.html[HSC Site] for a nicely rendered version of this manual.
+endif::env-github[]
+
 The Command Line Interface (CLI) module of HTML Sanity Check (xref:{xrefToManual}[HSC]) enables to check generated or native HTML documentation from the command line.
 
 == Installation (Command Line Interface)
 
 === Prerequisites
 
-* Java 8 or higher (`java` executable required on the OS search path (`${PATH} on Linux/macOS, `%path%` on Windows).
+* Java 8 or higher (`java` executable required on the OS search path (`+${PATH}+` on Linux/macOS, `%path%` on Windows).
 
 === Download
 
@@ -49,7 +53,7 @@ The CLI tool exposes a few options as part of its configuration:
 +
 Type: Directory
 +
-Default: Currrent directory (`.`)
+Default: Current directory (`.`)
 
 `--sourceDocuments` <...> (optional):: An override to process several source files, which must be a subset of all files available in `sourceDir`.
 +

htmlSanityCheck-gradle-plugin/README.adoc

@@ -12,6 +12,10 @@ ifndef::xrefToManual[:xrefToManual: ../README.adoc]
 :gradleProperties: link:../gradle.properties[]
 ifdef::jbake-type[:gradleProperties: {project-url}/blob/develop/gradle.properties[]]
 
+ifdef::env-github[]
+TIP: Use the https://hsc.aim42.org/manual/30_gradle-plugin.html[HSC Site] for a nicely rendered version of this manual.
+endif::env-github[]
+
 The {gradle-url}[Gradle] plugin of HTML Sanity Check (xref:{xrefToManual}[HSC]) enables to check generated or native HTML documentation from the Gradle build.
 
 [[sec:installation]]

htmlSanityCheck-maven-plugin/README.adoc

@@ -11,6 +11,10 @@ ifndef::xrefToManual[:xrefToManual: ../README.adoc]
 :mavenProperties: link:../maven.properties[]
 ifdef::jbake-type[:mavenProperties: {project-url}/blob/develop/maven.properties[]]
 
+ifdef::env-github[]
+TIP: Use the https://hsc.aim42.org/manual/40_maven-plugin.html[HSC Site] for a nicely rendered version of this manual.
+endif::env-github[]
+
 The {maven-url}[Maven] plugin of HTML Sanity Check (xref:{xrefToManual}[HSC]) enables to check generated or native HTML documentation from the Maven build.
 
 [[sec:installation]]
@@ -44,7 +48,7 @@ Use the following snippet inside a Maven build file:
 </plugin>
 ----
 <1> Checkout <<box:current-version,current version>>
-<2> List the files you want tio check here.
+<2> List the files you want to check here.
 <3> Directory where the HTML files are located.
 
 [[box:current-version]]