我有标准 gradle 布局的非常标准的 java 项目,所有源都存储在 git 中。我想用markdown(或类似的标记语言)编写文档并将所有文件保存在项目目录中(例如根目录中的docs/文件夹)。然后我想生成静态站点或将我的源推送到某个地方以访问 html 中的完整文档(应该是自托管解决方案)。
如果我能够添加到其他文章的简单链接(就像我在任何 wiki 引擎中使用 那样做[[article]]
),那就太好了。如果我能够通过与文章链接相同的技术添加到 javadoc 的快速链接,那将是完美的。如果它有内置的搜索引擎也将是完美的。
我已经使用了几个静态站点生成器,但我没有找到至少可以满足我一半要求的任何东西。有没有类似的东西?或者我需要自己编写代码(我知道不会花太多时间)?也许文档有更常见的用例?