繁体   English   中英

使用Maven创建用户指南文档

[英]Create User Guide documentation with Maven

我需要编写和构建易于维护,美观的工具,以更改pdf和html 5格式的文档。 源格式必须易于编辑。 这个Maven插件必须支持我公司的组织化主题(字体,颜色,图片等),TOC生成,不同文件中章节的分隔,图像文件的集成,在文档中放入代码段的简便方法。 我有Maven版本,但我想知道当前最好的决定是什么?

我正在研究两个选择:

  • Doxia-使用md(markdown)作为输入格式。 有WSWG md免费编辑器,支持许多aforemention内容,等等。其构件需要外部仓库。
  • Asciidoctor-使用asdcii doc作为输入格式。 支持使用片段等进行模板化

使用此插件的优点和缺点是什么? 还有其他好的解决方案吗?

从我先与Doxia建立文档,然后再与AsciiDoc建立文档的过程中,我意识到Asciidoc更好。 它允许

  • 使用yaml文件轻松进行样式设置。 默认样式也很好。
  • Asciidoc作为标记语言是非常好的证明: 乌德指南AsciiDoc
  • 具有良好的在线编辑器,并且该语言比例如markdown功能强大,并且与xml格式相比更易于编写。
  • 与Maven和ascii doc一起使用时的良好示例 ,并且易于理解的配置

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM