使用 Maven 创建用户指南文档
Create User Guide documentation with Maven
我需要编写和构建易于维护、美观、易于更改的 pdf 和 html 5 格式的文档。源格式必须易于编辑。这个 Maven 插件必须支持我公司的组织(字体、颜色、图片等)、TOC 生成、不同文件中的章节分离、图像文件集成、将代码片段放入文档中的简便方法。我有 Maven 构建,我想知道目前最好的决定是什么?
我正在研究两个选项:
- Doxia - 使用 md(markdown) 作为输入格式。有 WSWG md 免费
编辑器,支持很多上述的东西,等等。它的工件需要外部回购。
- Asciidoctor - 使用 asdcii doc 作为输入格式。支持使用片段等模板
使用这个插件有什么优缺点?
还有其他好的解决方案吗?
从我尝试首先使用 Doxia 然后使用 AsciiDoc 构建文档的尝试中,我意识到 Asciidoc 更好。它允许
- 使用 yaml 文件轻松设置样式。 Default造型也很不错
- Asciidoc 作为标记语言 非常 有据可查:Uder Guide AsciiDoc
- 在线不错editors,语言比markdown更强大,比起xml格式更容易写。
- 好examples when using with Maven and ascii doc and easy to understand configurations.
我需要编写和构建易于维护、美观、易于更改的 pdf 和 html 5 格式的文档。源格式必须易于编辑。这个 Maven 插件必须支持我公司的组织(字体、颜色、图片等)、TOC 生成、不同文件中的章节分离、图像文件集成、将代码片段放入文档中的简便方法。我有 Maven 构建,我想知道目前最好的决定是什么?
我正在研究两个选项:
- Doxia - 使用 md(markdown) 作为输入格式。有 WSWG md 免费 编辑器,支持很多上述的东西,等等。它的工件需要外部回购。
- Asciidoctor - 使用 asdcii doc 作为输入格式。支持使用片段等模板
使用这个插件有什么优缺点? 还有其他好的解决方案吗?
从我尝试首先使用 Doxia 然后使用 AsciiDoc 构建文档的尝试中,我意识到 Asciidoc 更好。它允许
- 使用 yaml 文件轻松设置样式。 Default造型也很不错
- Asciidoc 作为标记语言 非常 有据可查:Uder Guide AsciiDoc
- 在线不错editors,语言比markdown更强大,比起xml格式更容易写。
- 好examples when using with Maven and ascii doc and easy to understand configurations.