Miredot | Configuring the Output

Reference Manual

Configuring the Output

By default, Miredot generates an HTML site of your code. If you want to generate MS Word DOCX or RAML , you need to indicate this.

With the configuration below, all outputs are generated. Each of the output formats has a set of common and specific configuration options. All are optional. Each output format can be included at most once in the configuration section.

Maven

<configuration>
    <output>
        <!-- optional common configuration -->
        <html>
            <!-- optional html configuration -->
        </html>
        <docx>
            <!-- optional docx configuration -->
        </docx>
        <raml>
            <!-- optional raml configuration -->
        </raml>
    </output>
</configuration>

Gradle

miredot {
    output {
        formats {
            'html' {
                // optional config e.g., location = 'out/html
            }
            'docx' {
                // optional config e.g., location = 'out/docx
            }
            'raml' {
                // optional config e.g., location = 'out/raml
            }
        }
    }
}

The formats section is required.