从spring rest docs生成ascii doc api文档

问题描述 投票:0回答:1

使用Spring rest docs,您可以生成一系列精彩的asciidocs作为单独的片段。

http://www.baeldung.com/spring-rest-docs在描述我遵循的过程方面做得很好。

在生成片段之后,我根据教程使用asciidoctor-maven-plugin将它们组合成一个文件来存档。

有没有办法生成单个.adoc文件而不是前面提到的html文件?

在配置中,它允许您指定“后端”:

<backend>html</backend>

http://asciidoctor.org/docs/convert-documents/#selecting-an-output-format https://github.com/asciidoctor/asciidoctor-maven-plugin

...但我希望将asciidoc保留为最终文件格式。

我发现的最接近的评论是:https://github.com/asciidoctor/asciidoctor/issues/168#issuecomment-58861372

......但我不太明白如何将它应用到我的情况中。

java spring asciidoctor spring-restdocs
1个回答
1
投票

如果我理解您的链接正确,则无法使用提供的解决方案与maven插件。目前它不支持导出asciidoctor文件。你必须

  1. 安装ruby和ascidoctor gem
  2. 下载脚本https://raw.githubusercontent.com/asciidoctor/asciidoctor-extensions-lab/master/scripts/asciidoc-coalescer.rb
  3. 使用ruby运行脚本asciidoc-coalescer.rb your_file_name.adoc> single_file.adoc
  4. 祈祷脚本有效,你不会遇到你发布的帖子中遇到的麻烦。您的输出应该在single_file.adoc中
© www.soinside.com 2019 - 2024. All rights reserved.