kotlinfooterkotlin-dokka

How can I add a footer to Kotlin Dokka docs?


I am looking for a way to include text in the footer of all Dokka generated docs. I am not seeing this option being advertised by the Gradle or Maven plugins for Dokka.

Is this possible? Can you point me to a sample?


Solution

  • If you have Maven project then you can do it by adding plugin into pom.xml

            <plugin>
                <groupId>org.jetbrains.dokka</groupId>
                <artifactId>dokka-maven-plugin</artifactId>
                <version>1.9.20</version>
                <executions>
                    <execution>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>dokka</goal>
                            <goal>javadoc</goal>
                            <goal>javadocJar</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <moduleName>Demo App</moduleName>
                    <skipEmptyPackages>true</skipEmptyPackages>
                    <includeNonPublic>true</includeNonPublic>
                    <includes>
                        <include>module.md</include>
                        <include>src/main/kotlin/org/demo/gear/package.md</include>
                        <include>src/main/kotlin/org/demo/utils/misc/package.md</include>
                        <include>src/main/kotlin/org/demo/app/package.md</include>
                    </includes>
                    <samples>
                        <dir>src/test</dir>
                        <dir>src/main</dir>
                    </samples>
                    <pluginsConfiguration>
                        <org.jetbrains.dokka.base.DokkaBase>
                            <footerMessage>
                                <![CDATA[2025 <a href="https://demo.org/">demo.org</a>]]>
                            </footerMessage>
                            <separateInheritedMembers>true</separateInheritedMembers>
                        </org.jetbrains.dokka.base.DokkaBase>
                    </pluginsConfiguration>
                </configuration>
            </plugin>