当前位置:  开发笔记 > 前端 > 正文

使用maven创建文档

如何解决《使用maven创建文档》经验,为你挑选了2个好方法。

我正处于重访maven的过程中.当我们上次查看这个时,我们的团队经历了糟糕的经历,因为在maven从1.x重新架构到2.x期间,我们需要的很多依赖项没有被移动到新的存储库中.但是,我现在有时间重新考虑.

我有兴趣使用maven和LaTeX或DocBook来创建文档,我想知道是否有人有任何共享经验,项目/模块结构,使用好的插件等等...

非常感谢 :-)

编辑:

只是为了澄清,我正在寻找一篇技术文章/书,而我想要的工件可能是PDF.



1> tunaranch..:

DocBook是Doxia的众多支持输入之一,Doxia是用于通过maven生成docs的引擎.请参阅此处:http://maven.apache.org/doxia/modules/index.html

事实上,Doxia网站会回答您的确切问题:http://maven.apache.org/doxia/book/index.html



2> Romain Linso..:

您可以使用mvn site命令(即使用插件站点)轻松地使用Maven创建一个站点(包含文档).

此插件创建技术报告(例如Javadoc,单元测试报告,代码覆盖率......),但也可用于创建"真实站点".您在此页面中有更多详细信息.

基本上,您使用APT(几乎纯文本,非常容易理解)或基于XML的格式Xdoc来编写页面.

2年前,我使用XDoc格式和Site Maven插件为我开发的一个应用程序创建了完整的用户指南.在全球范围内,它很容易创建!

我希望这能帮到您!

推荐阅读
围脖上的博博_771
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有