Skip to content

Commit

Permalink
Fix GitHub representation of AsciiDoc READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
ascheman committed Aug 15, 2024
1 parent 51cc2d8 commit e01b1ee
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions htmlSanityCheck-gradle-plugin/README.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= HSC Gradle Plugin
:doctype: book
include::../asciidoctor-config.ad[]

Expand All @@ -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]]
Expand Down

0 comments on commit e01b1ee

Please sign in to comment.