java项目的文档(markdown)

时间:2015-03-02 23:25:55

标签: java gradle documentation documentation-generation static-site

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

如果我能够添加到其他文章的简单链接(比如我在任何wiki引擎中使用[[article]]),那将会很好。如果我能够通过与文章链接相同的技术添加到javadoc的快速链接,那将是完美的。如果它有内置的搜索引擎,它也将是完美的。

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

1 个答案:

答案 0 :(得分:2)

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

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