https://github.com/dashorst/wicketguide
An Asciidoctor version of the Wicket Guide
https://github.com/dashorst/wicketguide
Last synced: 11 months ago
JSON representation
An Asciidoctor version of the Wicket Guide
- Host: GitHub
- URL: https://github.com/dashorst/wicketguide
- Owner: dashorst
- Created: 2014-11-03T10:23:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-11-03T12:19:25.000Z (over 11 years ago)
- Last Synced: 2025-08-14T11:51:35.234Z (11 months ago)
- Language: Java
- Size: 176 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= Apache Wicket Reference Guide
A Living and Breathing Reference Guide for Apache Wicket
:article:
This project features an alternative to the current GDoc based Reference Guide
for Apache Wicket. As GDoc is declining in use (Groovy and Grails are migrating
to Asciidoctor.org) and Asciidoctor.org is becoming more mainstream it seems
like a good idea to evaluate what it brings to the table.
== Living Code
The major benefit of using Asciidoctor is that it can run in a Maven build and
that you can include snippets of code from your Java project. This makes sure
that the examples in the Reference Guide actually compile, and if we do it right
that they even work as advertised.
You can see this link:src/main/asciidoc/ajax/ajaxbehaviours.adoc[in action in the docs here].
== Caveats
The current Maven setup doesn't work properly with including tagged regions from
XML/HTML files, but the most recent (1.5.1) commandline Asciidoctor does work as
advertised.
To generate the docs use:
[source,bash]
----
./gendocs
----
which will start Asciidoctor using the same commandline the Maven plugin does
(without some incompatible commandline options). The generated documentation can
be found in `target/generated-resources/index.html`
When the *Asciidoctor Maven Plugin* **finally** ships with a working XML/HTML
tag based include directive we can remove this `gendocs` file and fully rely on
Maven as God intended.