-
Content for this guide is in Asciidoc format and the entry file is
contents/index.adoc. -
Place new images under
contents/images. -
Add testable code snippets to
srcfolder as appropriate for this guide. -
Commits to
masterwill automatically be published togh-pagesif the build is successful. -
To build documentation run
./gradlew asciidoctorand find the results inbuild/asciidoc/html5. -
To test code snippets run
./gradlew check. -
To see which attributes are passed to the
asciidoctortask, run./gradlew asciidoctorAttributes
Before pushing your guide, please run ./gradlew checkLinks to validate remote hyperlinks.