This is the arqiva's official documentation project. You can read the online documentation as we write by clicking here.
Arqiva's primary goal was to help us easily produce great documentation for Hi-Framework. We were using Daux.io which was not proving itself to be flexible and awesome enough.
- Its Java based
- Its highly extensible: Arqiva has an architecture inspired by Maven in terms of modularity and allows teams to build personalized documentation without having to look for another documentation tool. Teams can choose or build their own template engine, they can even pick their preferred markdown parser with the flavours they love. Arqiva provides hooks to let third-party java code transform the generated HTML in the different phases it observes.
- Its built to work with an awesome built tool: Maven. Adding a new module means nothing but adding a new maven dependency
If you are looking for arqiva's source code, you will find below the different repositories where you will be able to find arqiva's artifacts source-code.
The core of arqiva. Implements the core concepts: project, context, topic files, topic tree, modules (extensibility), hooks. The source code of this artifact is located at https://github.com/talk-code/Arqiva-core. Java docs can be found here.
This artifact provides the infrastructure to render arqiva docs from a java web-container. The source code of this artifact is located at https://github.com/talk-code/Arqiva-web.
This artifact consists of the maven plugin used to run and build arqiva projects. The source code of this artifact is located at https://github.com/talk-code/Arqiva-mojo.
This artifact consists of the arqiva-basic module. It's module that integrates Apache Velocity and the Java implementation of CommonMark by atlassian into the Arqiva's ecosystem. The source code of this artifact is located at https://github.com/talk-code/Arqiva-mojo.
<repository>
<id>Emerjoin</id>
<name>maven-repo</name>
<url>https://github.com/Emerjoin/maven-repo/raw/master</url>
</repository>