This tutorial walks you through creating and deploying Znai documentation as GitHub pages

You have a GitHub project named This project is not java based Despite not dealing with java you have JDK and Maven installed my project

Create a directory It will be a place where your documentation resides Znai will create a directory inside the directory In the directory create a file with the znai plugin Note Make sure that the is the same as the name of your project Znai assumes that the site is deployed with some common prefix It will build HTML in a way it tries to use the as a root You need document root to correctly serve files from docs znai docs docs pom xml docId https <username> github io https <username> github io <project name>

In the directory run maven command to scaffold the documentation The command creates znai project structure in directory docs mvn znai new docs znai

Open live preview of your znai site In the directory run the command Follow the guidelines on the znai project website docs mvn znai preview