plugins { id 'org.aim42.{project}' version '{hsc-version}' // (1) }

buildscript { repositories { // maven { url "{jitpack-url}" } // (1) mavenCentral() // (2) gradlePluginPortal() // (3) } dependencies { classpath ('gradle.plugin.org.aim42:{project}:{hsc-version}') // (4) } } apply plugin: 'org.aim42.{project}'

apply plugin: 'org.aim42.htmlSanityCheck' htmlSanityCheck { sourceDir = file( "$buildDir/docs" ) // where to put results of sanityChecks... checkingResultsDir = file( "$buildDir/report/htmlchecks" ) // fail build on errors? failOnErrors = true }

import org.aim42.htmlsanitycheck.check.* buildscript { repositories { mavenCentral() // This is only necessary for older releases (< 2.00) gradlePluginPortal() } } plugins { id 'org.aim42.htmlsanitycheck' version '{hsc-version}' id 'org.asciidoctor.convert' version '1.5.8' } // ==== path definitions ===== // =========================== // location of AsciiDoc files def asciidocSrcPath = "$projectDir/src/asciidoc" // location of images used in AsciiDoc documentation def srcImagesPath = "$asciidocSrcPath/images" // results of asciidoc compilation (HTML) // (input for htmlSanityCheck) // this is the default path for asciidoc-gradle-convert def htmlOutputPath = "$buildDir/asciidoc/html5" // images used by generated html def targetImagesPath = htmlOutputPath + "/images" // where HTMLSanityCheck checking results ares stored def checkingResultsPath = "$buildDir/report/htmlchecks" apply plugin: 'org.asciidoctor.convert' asciidoctor { sourceDir = new File( asciidocSrcPath ) options backends: ['html5'], doctype: 'book', icons: 'font', sectlink: true, sectanchors: true resources { from( srcImagesPath ) into targetImagesPath } } apply plugin: 'org.aim42.htmlSanityCheck' htmlSanityCheck { // ensure asciidoctor->html runs first // and images are copied to build directory dependsOn asciidoctor sourceDir = new File( htmlOutputPath ) // files to check, specified as a file tree with filtering sourceDocuments = fileTree(sourceDir) { include "many-errors.html", "no-errors.html" } // where to put results of sanityChecks... checkingResultsDir = new File( checkingResultsPath ) // fail build on errors failOnErrors = true // http connection timeout in milliseconds httpConnectionTimeout = 1000 // which statuscodes shall be interpreted as warning, error or success // defaults to standard httpWarningCodes = [401] // httpErrorCodes // httpSuccessCodes // only execute a subset of all available checks // available checker: // * BrokenCrossReferencesChecker // * BrokenHttpLinksChecker // * DuplicateIdChecker // * ImageMapChecker // * MissingAltInImageTagsChecker // * MissingImageFilesChecker // * MissingLocalResourcesChecker checkerClasses = [DuplicateIdChecker, MissingImageFilesChecker] // Exclude from checking excludes = ["(http|https)://exclude.this/url.*", ".*skip-host.org.*", "https://www.baeldung.com/.*"] // <1> }