java - java项目文档(markdown)

标签 java gradle documentation documentation-generation static-site

<分区>

我有一个非常标准的 java 项目,具有标准的 gradle 布局,所有源都存储在 git 中。我想用 Markdown (或类似的标记语言)编写文档并将所有文件保存在项目目录中(例如根目录中的 docs/文件夹)。然后我想生成静态站点或将我的源代码推送到某个地方以访问 html 中的完整文档(应该是自托管解决方案)。

如果我能够添加指向其他文章的简单链接(就像我在任何 wiki 引擎中使用 [[article]] 所做的那样),那就太好了。如果我能够通过与文章链接相同的技术添加到 javadoc 的快速链接,那将是完美的。如果内置搜索引擎就更完美了。

我已经使用了几个静态站点生成器,但我没有找到任何可以至少满足我一半要求的东西。有类似的东西吗?或者我需要自己编写代码(我知道不会花太多时间)?也许有更常见的文档用例?

最佳答案

您必须使用 Doclet 的概念。那里有一些。也许只是试试这个:

https://github.com/Abnaxos/pegdown-doclet

关于java - java项目文档(markdown),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28821344/

相关文章:

java - 无法解析符号 'java'

java - 使用 Java DOM 将新元素添加到 xml 文件

android - Apk 版本名称 - jenkins

gradle - Gradle 4.4需要Java 7或更高版本才能运行。您的构建当前已配置为使用Java 6

python - 是否有一种编程方式可以将一系列图像文件转换为 PDF?

java - 在动态 Web 表格中滚动时会随机跳过某些行

java - 将 double 舍入到小数点后 2 位

java - 创建 gradle 插件时将生成的 java 或 kotlin 源代码放在哪里?

没有显示源代码的godoc

.class 文件的 Java 语言命名约定