Reference Guide brushed up and converted to AsciiDoc

While we pride ourselves on providing a comprehensive and detailed documentation, the MapStruct reference guide grew out of form a bit over time. To name just one issue, readability wasn’t great on smaller screen sizes.

All that’s history now, the reference guide has been converted into the AsciiDoc format, which makes the documentation much easier to maintain and allows for several publishing options using the fantastic AsciiDoctor tool.

The guide is provided in two formats now: HTML and as PDF. The actual contents is largely unchanged, but we moved some sections around in order to reduce the number of chapters to a more digestable level. It’s high on our agenda to rewrite some parts of the guide which aren’t perfect yet, which should be much lesser of a burden now thanks to AsciiDoc.

In addition, you also can find the API JavaDoc online now.

The main documentation page page which previously just contained the reference documentation has been revamped into a landing page for all thing related to documentation. It provides links to the reference guide, example projects and many useful resources around MapStruct provided at other places on the web, such as blog posts and conference presentation slides.


comments powered by Disqus