从 spring rest 文档生成 ascii doc api 文档
Generate ascii doc api documentation from spring rest docs
使用 Spring rest 文档,您可以生成一系列不错的 asciidoc 作为单独的片段。
http://www.baeldung.com/spring-rest-docs 很好地描述了我遵循的过程。
生成片段后,根据教程,我使用 asciidoctor-maven-plugin 将它们组合成一个文件以供文档使用。
有没有办法生成单个 .adoc 文件而不是前面提到的 html 文件?
在配置中,它允许您指定 "backend" 为:
<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
...但我不太明白如何将它应用到我的情况中。
如果我理解你的 link 正确,你不能将提供的解决方案与 maven 插件一起使用。目前它不支持导出 asciidoctor 文件。你必须
- 安装 ruby 和 ascidoctor gem
- 下载脚本https://raw.githubusercontent.com/asciidoctor/asciidoctor-extensions-lab/master/scripts/asciidoc-coalescer.rb
- 运行 带有 ruby asciidoc-coalescer.rb 的脚本 your_file_name.adoc > single_file.adoc
- 祈祷脚本能正常工作,并且您不会 运行 陷入您发布的主题中提到的麻烦。你的输出应该在 single_file.adoc
使用 Spring rest 文档,您可以生成一系列不错的 asciidoc 作为单独的片段。
http://www.baeldung.com/spring-rest-docs 很好地描述了我遵循的过程。
生成片段后,根据教程,我使用 asciidoctor-maven-plugin 将它们组合成一个文件以供文档使用。
有没有办法生成单个 .adoc 文件而不是前面提到的 html 文件?
在配置中,它允许您指定 "backend" 为:
<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
...但我不太明白如何将它应用到我的情况中。
如果我理解你的 link 正确,你不能将提供的解决方案与 maven 插件一起使用。目前它不支持导出 asciidoctor 文件。你必须
- 安装 ruby 和 ascidoctor gem
- 下载脚本https://raw.githubusercontent.com/asciidoctor/asciidoctor-extensions-lab/master/scripts/asciidoc-coalescer.rb
- 运行 带有 ruby asciidoc-coalescer.rb 的脚本 your_file_name.adoc > single_file.adoc
- 祈祷脚本能正常工作,并且您不会 运行 陷入您发布的主题中提到的麻烦。你的输出应该在 single_file.adoc