Maven - Project Documents

This tutorial will teach you how to create documentation of the application in one go. So let's start, go to C:/MVN directory where you had created your java consumerBanking application using the examples given in the previous chapters. Open consumerBanking folder and execute the following mvn command.

Update, the pom.xml in C:\MVN\consumerBanking folder as shown below.

<project xmlns="" xmlns:xsi=""
C:\MVN\consumerBanking>mvn site

Maven will start building the project.

[INFO] Scanning for projects...
[INFO] ----------------< >----------------
[INFO] Building consumerBanking 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] --- maven-site-plugin:3.7:site (default-site) @ consumerBanking ---
[WARNING] Input file encoding has not been set, using platform encoding Cp1252, i.e. build is platform dependent!
[INFO] Relativizing decoration links with respect to localized project URL:
[INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.2 skin.
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  5.850 s
[INFO] Finished at: 2021-12-13T17:49:56+05:30
[INFO] ------------------------------------------------------------------------

Your project documentation is now ready. Maven has created a site within the target directory.

documentation site pages

Open C:\MVN\consumerBanking\target\site folder. Click on index.html to see the documentation.

consumer web page

Maven creates the documentation using a documentation-processing engine called Doxia which reads multiple source formats into a common document model. To write documentation for your project, you can write your content in a following few commonly used formats which are parsed by Doxia.

Format Name Description Reference
XDoc A Maven 1.x documentation format

FML Used for FAQ documents