You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何向Dokka生成的Kotlin KDoc文档添加额外Markdown内容?

如何在Dokka文档树中添加独立的额外文档页面

当然可以添加user-guide.md这类独立文档页面到Dokka生成的文档树里,以下是主流构建工具下的具体操作方式:

Gradle 构建项目

  • 在项目的src/main/resources目录下创建docs文件夹(路径可自定义,后续配置对应即可),将user-guide.md放入其中。
  • 在build.gradle.kts(或build.gradle)的Dokka配置块中,通过includes参数指定该文件路径,示例配置:
tasks.dokkaHtml {
    dokkaSourceSets {
        named("main") {
            includes.from("src/main/resources/docs/user-guide.md")
        }
    }
}
  • 配置完成后,生成的文档会自动整合user-guide.md的内容,通常会出现在文档树的根节点或指定层级(可通过moduleName等参数调整展示位置)。

Maven 构建项目

  • 在项目的src/main/resources下创建docs目录,放入user-guide.md。
  • 在pom.xml的Dokka插件配置中,添加<includes>标签指定文件路径,示例:
<plugin>
    <groupId>org.jetbrains.dokka</groupId>
    <artifactId>dokka-maven-plugin</artifactId>
    <version>你的Dokka版本</version>
    <executions>
        <execution>
            <goals>
                <goal>dokka</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <includes>
            <include>src/main/resources/docs/user-guide.md</include>
        </includes>
    </configuration>
</plugin>

如果想给页面设置更清晰的展示名称或调整在文档树中的位置,可在user-guide.md开头添加Dokka支持的元信息,示例:

# 入门指南
@file:JvmName("UserGuide")

这样生成的文档会以“入门指南”作为页面标题,而非文件名。

内容的提问来源于stack exchange,提问作者LBushkin

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.28 17:44:53