Skip to content

Commit

Permalink
WIP 309 Extend Manuals
Browse files Browse the repository at this point in the history
- Add Gradle Plugin manual
- Fix links in manuals/READMEs
  • Loading branch information
ascheman committed Apr 25, 2024
1 parent 7fc6efc commit 1d9fbe7
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.adoc
Expand Up @@ -2,6 +2,8 @@
// ifndef::sourceDir[:sourcedir: .]
include::asciidoctor-config.ad[]

ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/README.adoc]

[.lead]
====
This project provides some basic sanity checking on html files.
Expand All @@ -14,7 +16,7 @@ or broken links.
It can be currently used

* Programmatically from Java (or other JVM languages), or
* As a xref:htmlSanityCheck-gradle-plugin/README.adoc[Gradle plugin].
* As a xref:{xrefToGradlePlugin}[Gradle plugin].
Standalone Java (CLI) executable and a https://maven.apache.org[Apache Maven] Plugin are planned for future releases.

Expand Down Expand Up @@ -322,6 +324,6 @@ Some day we'll unify that :-)

== Kudos

Big thanx to image:./structure101-logo.png[alt='Structure-101',link="https://structure101.com"] for helping us analyze and restructure our code.
Big thanx to image:structure101-logo.png[alt='Structure-101',link="https://structure101.com"] for helping us analyze and restructure our code.


2 changes: 1 addition & 1 deletion asciidoctor-config.ad
@@ -1,6 +1,6 @@
:icons: font
:toc: left
:imagesdir: .
ifndef::imagesdir[:imagesdir: .]

// :outfilesuffix: adoc

Expand Down
10 changes: 8 additions & 2 deletions htmlSanityCheck-gradle-plugin/README.adoc
@@ -1,9 +1,15 @@
:doctype: book
include::../asciidoctor-config.ad[]

ifndef::xrefToManual[:xrefToManual: ../README.adoc]
:gradleProperties: link:../gradle.properties[]
ifdef::jbake-type[]
:gradleProperties: {project-url}/gradle.properties[]
endif::jbake-type[]

= HSC Gradle Plugin

The {gradle-url}[Gradle] plugin of HTML Sanity Check (xref:../README.adoc[HSC]) enables to check generated or native HTML documentation from the Gradle build.
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]]
== Installation (Gradle Plugin)
Expand Down Expand Up @@ -63,7 +69,7 @@ apply plugin: 'org.aim42.{project}'
[IMPORTANT]
.Latest (development) version
====
The current development version is defined in link:../gradle.properties[]
The current development version is defined in {gradleProperties}
[source]
----
Expand Down
10 changes: 10 additions & 0 deletions src/docs/manual/01_gradle-plugin.adoc
@@ -0,0 +1,10 @@
:filename: manual/01_gradle-plugin.adoc
:imagesdir: ../images
:jbake-menu: Manual
:jbake-order: 30
:jbake-title: HTML Sanity Check (Gradle Plugin)

ifndef::projectRootDir[:projectRootDir: ../../..]
:xrefToManual: 01_manual.adoc

include::{projectRootDir}/htmlSanityCheck-gradle-plugin/README.adoc[leveloffset=+1]
4 changes: 3 additions & 1 deletion src/docs/manual/01_manual.adoc
@@ -1,8 +1,10 @@
:filename: manual/01_manual.adoc
:imagesdir: ../images
:jbake-menu: Manual
:jbake-title: HTML Sanity Check
:jbake-order: 10
:jbake-title: HTML Sanity Check (Generic)

ifndef::projectRootDir[:projectRootDir: ../../..]
:xrefToGradlePlugin: 01_gradle-plugin.adoc

include::{projectRootDir}/README.adoc[leveloffset=+1]

0 comments on commit 1d9fbe7

Please sign in to comment.