【问题标题】:Documentation for java project (markdown) [closed]java项目的文档(markdown)[关闭]
【发布时间】:2015-05-03 11:41:02
【问题描述】:

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

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

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

【问题讨论】:

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


    【解决方案1】:

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

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2014-02-12
      • 2021-01-26
      • 2012-04-04
      • 2010-10-01
      • 2013-05-11
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多