FAQ  Include Miredot documentation to your application deployment

Problem

You would like to host your documentation alongside your application, but Miredot generates offline documentation which is by default not packaged with your application.

Solution

If you would like to host the generated documentation next to your application, you can include the generated documentation to your war file using the maven war plugin.

Configure your maven war plugin as follows:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.6</version>
    <configuration>
        <webResources>
            <resource>
                <!-- should point to the miredot generated dir -->
                <directory>${project.parent.basedir}/my-api-module/target/miredot</directory>
                <!-- the dir where you want miredot to be copied to under web apps -->
                <targetPath>miredot</targetPath>
                <includes>
                    <include>**</include>
                </includes>
            </resource>
        </webResources>
    </configuration>
</plugin>