Getting started

What is arqiva?

Arqiva is an extensible java based tool that allows you to write awesome API documentations without much effort using Markdown and HTML together.

Requirements to get started

Git

Java 8 + Git + Maven 3.3.x

Clone the start-project

The start-project is a maven-project configured with the arqiva-maven-plugin which starts an embedded web-server to display our docs in a browser as we write them. It also allows to build our project into static html writing only 3 words.

    git clone https://github.com/Emerjoin/Arqiva-start-project.git

Run the project

    mvn arqiva:run

Wait for the following log to appear on your command line:

    INFO: Starting ProtocolHandler ["http-nio-9610"]

Display the index page on your favorite web-browser

    http://localhost:9610/arqiva/index.html

→ Next