From ff56f4647abd6533ed97db865366d5790d4672a2 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Thu, 15 Aug 2024 12:19:10 +0200 Subject: [PATCH] Fix GitHub representation of AsciiDoc READMEs --- README.adoc | 5 +++-- htmlSanityCheck-gradle-plugin/README.adoc | 3 +-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index 864bcdf1..3f23d964 100644 --- a/README.adoc +++ b/README.adoc @@ -1,11 +1,12 @@ -include::asciidoctor-config.ad[] = image:htmlsanitycheck-logo.png[HSC] Html Sanity Check (HSC) +:doctype: book +include::asciidoctor-config.ad[] ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/README.adoc] [.lead] ==== -This project provides some basic sanity checking on HTML files. +https://aim42.github.io/htmlSanityCheck[HTML Sanity Check] (HSC) provides some basic sanity checking on HTML files. It can be helpful in case of HTML generated from, e.g., {asciidoc-url}[Asciidoctor], Markdown or other formats -- as converters usually don't check for missing images diff --git a/htmlSanityCheck-gradle-plugin/README.adoc b/htmlSanityCheck-gradle-plugin/README.adoc index 36632079..98cd1dd6 100644 --- a/htmlSanityCheck-gradle-plugin/README.adoc +++ b/htmlSanityCheck-gradle-plugin/README.adoc @@ -1,3 +1,4 @@ += HSC Gradle Plugin :doctype: book include::../asciidoctor-config.ad[] @@ -7,8 +8,6 @@ ifdef::jbake-type[] :gradleProperties: {project-url}/blob/develop/gradle.properties[] endif::jbake-type[] -= HSC Gradle Plugin - 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]]