Miredot | Base URL <span class="protag"/>

Reference Manual

Base URL

You can specify the URL on which your REST API is available. This value will be prepended to all rest resources. This option is only available for the html output.

Maven

<configuration>
    <output>
        <html>
            <baseUrl>http://www.miredot.com/rest</baseUrl>
        </html>
    </output>
</configuration>

Gradle

miredot {
    output {
        formats {
            'html' {
                baseUrl = 'http://www.miredot.com/rest'
            }
        }
    }
}

The website that is generated by Miredot PRO supports a query parameter that allows you to set the base url dynamically. (For example, http://www.miredot.com/exampledocs/?baseUrl=http:%2F%2Fwww.alternativedomain.com). This can be useful if you wish to offer your customers personalised documentation based on their own domain.