- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
作为构建我的项目的一部分,我希望 Dokka 的 maven 插件构建一个 Markdown wiki,我可以将其部署到 github 而无需修改。我构建 Markdown 并通过 intellij 查看文档没有问题,但我希望将它直接托管在我项目的 github wiki 中。如果有人有任何想法如何做到这一点,那就太好了。
这是我目前的 Dokka 配置
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>0.9.16</version>
<executions>
<execution>
<phase>pre-site</phase>
<goals>
<goal>dokka</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- Set to true to skip dokka task, default: false -->
<skip>false</skip>
<outputFormat>gfm</outputFormat>
<!-- Default: ${project.basedir}/target/dokka -->
<outputDir>${project.basedir}/docs/privateurl</outputDir>
<!-- Use default or set to custom path to cache directory to enable package-list caching. -->
<!-- When set to default, caches stored in $USER_HOME/.cache/dokka -->
<cacheRoot>default</cacheRoot>
<!-- List of '.md' files with package and module docs -->
<!-- http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation -->
<includes>
<file>packages.md</file>
<file>extra.md</file>
</includes>
<!-- Used for linking to JDK, default: 6 -->
<jdkVersion>8</jdkVersion>
<!-- Do not output deprecated members, applies globally, can be overridden by packageOptions -->
<skipDeprecated>true</skipDeprecated>
<!-- Emit warnings about not documented members, applies globally, also can be overridden by packageOptions -->
<reportNotDocumented>false</reportNotDocumented>
<!-- Do not create index pages for empty packages -->
<skipEmptyPackages>true</skipEmptyPackages>
<!-- See platforms section of documentation -->
<impliedPlatforms>
<platform>JVM</platform>
</impliedPlatforms>
<!-- Short form list of sourceRoots, by default, set to ${project.compileSourceRoots} -->
<sourceDirectories>
<dir>src/main</dir>
</sourceDirectories>
<!-- Specifies the location of the project source code on the Web. If provided, Dokka generates "source" links
for each declaration. -->
<sourceLinks>
<link>
<!-- Source directory -->
<dir>${project.basedir}/src/main</dir>
<!-- URL showing where the source code can be accessed through the web browser -->
<url>https://github.com/privateurl</url>
<!--Suffix which is used to append the line number to the URL. Use #L for GitHub -->
<urlSuffix>#L</urlSuffix>
</link>
</sourceLinks>
<!-- No default documentation link to kotlin-stdlib -->
<noStdlibLink>true</noStdlibLink>
</configuration>
</plugin>
最佳答案
这告诉 dokka 生成 md 文件而不是 HTML:
<outputFormat>markdown</outputFormat>
关于kotlin - 如何让 Dokka 生成可部署的 github wiki?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/49225060/
我是 Kotlin 和 Dokka 的新手;在维基和教程之后,我尝试使用 gradle 构建文件中的以下行为 dokka 文档工具设置我的项目: 在项目gradle文件中: classpath "or
我正在使用 dokka 为我自动生成 javadoc。尽管当它遇到不是来 self 的项目的任何类时,它会使用完全限定的名称。 是否可以仅使用类名并让 dokka 为其提供链接?例如: java.la
我的项目结构是一个多模块,每个模块都有相同的 dokka 任务 gradle dokka 插件给了我一些非常奇怪的结果: 首先,它通常需要我构建的一些工件,例如其他 modules.jar 文件,如果
我正在使用适用于 Android 的 Dokka v0.9.17。当我运行 ./gradlew dokka 时,它会生成文档,但它包含很多我不关心的包,比如 android.support.fragm
我将 dokka 示例目录指向我的测试源,这样我就可以在我的文档中使用 @sample 引用测试方法,并提供经过测试的示例。这行得通,除了现在 dokka 也为我的测试生成文档,这显然不是我想要的。
试图用一个漂亮的常规结构来记录一些 Kotlin 代码: 编号列表。 带有项目符号的子列表。 数字在列表的顶层正确继续的地方。 我所认为的 official Dokka page页面上甚至没有“列表”
我正在尝试将示例代码添加到我的 API 引用中。 我遵循此处突出显示的模式 https://androidessence.com/contributing-to-kotlin 能够创建我的示例项目并运
我想离线运行 Dokka 来生成文档,因为构建运行系统不需要互联网访问,因此需要离线生成文档。 这可能吗?如果是,请提出相同的建议。 谢谢比乃 由于它似乎无法离线工作,因此没有可用信息。 最佳答案 是
我正在寻找一种在所有 Dokka 生成的文档的页脚中包含文本的方法。我没有看到 Dokka 的 Gradle 或 Maven 插件宣传此选项。 这可能吗?你能给我指一个样本吗? 最佳答案 dokka中
当 Kotlin 和 Dokka 版本不兼容时,Gradle 和 Maven 构建中的事情可能会奇怪地中断。我在任何地方都找不到两者之间兼容版本的列表。版本兼容性如何? 注:这个问题是由作者 ( Se
假设有一个类,它的主构造函数有参数 param 我想在类的 doc block 中解析(链接到实际参数)。 /** Class A does something using [param]. @con
作为构建我的项目的一部分,我希望 Dokka 的 maven 插件构建一个 Markdown wiki,我可以将其部署到 github 而无需修改。我构建 Markdown 并通过 intellij
我最近将一个 java 组件迁移到了 kotlin。到目前为止,当我使用 maven 发布插件时,它也自动生成了 javadoc,它也被上传到 oss.sonatype.com。另一方面,Dokka
我使用 Dokka 为 View 子类生成文档。效果很好,但文档包含 View 基类的数百个公共(public)函数。有没有办法只记录我的子类公共(public)函数? 我尝试将这些选项添加到 Gra
如何向 Android 项目添加 Dokka 文档引擎支持,而不向依赖项部分添加额外的类路径。我有兼容性问题... Dokka 文档建议遵循以下内容,但它的类路径破坏了我的构建.. buildscri
我正在尝试在我的 android 项目上使用 dokka 来生成 kdoc。但是当我运行脚本 'modules:app [dokka]' 时出现这个错误:无法确定任务 ':app:dokka' 的依赖
当我尝试将gradle项目(spring-framework-master)导入到eclipse时,出现以下错误信息:我有什么 第一步: gradlew cleanIdea:spring-oxm:co
我正在尝试使用 Dokka 插件为 android Kotlin 应用程序生成 Javadoc。我将插件添加到我的 gradle 中: classpath "org.jetbrains.dokka:d
我想添加这样的评论 /** * @param scrollFraction In range [0..1]. */ 但是 Dokka/Kdoc 将方括号内的内容解释为引用。当您在 ID
我正在使用 KDoc/Dokka 为 android 库生成文档。 我有一个自定义 View ,它扩展了 LinearLayout . 问题是 LinearLayout包含数百个公共(public)方
我是一名优秀的程序员,十分优秀!