Spring REST 文档 - 如何配置 asciidoctor 任务以将生成的代码段包含到索引中？

Question

我有一个 index.adoc 文件位于： src/docs/asciidoc/index.adoc

含内容：include::{snippets}/add-measurement/curl-request.adoc[]

当我调用构建任务时，生成的片段在这里：build/generated-snippets/my-call/*.adoc

但是当我查看生成的 index.html 时发现片段不包括在内：

Unresolved directive in index.adoc - include::{snippets}/add-measurement/curl-request.adoc[]

我在 build.gradle 中的 asciidoctor 任务：

asciidoctor {
    dependsOn junitPlatformTest
}

当我将 sourceDir snippetsDir 添加到 asciidoctor gradle 任务时，每个片段都会转换为 html，但不会生成 index.html。

Answer 1

根据您的信息，snippetsDir 已配置，代码段已放置在预期的文件夹中，并且 AsciiDoctor sourceDir 已正确生成 index.html（但包含损坏的内容).所以似乎缺少的一件事是将 snippetDir 传递给 AsciiDoctor:

asciidoctor {
  inputs.dir snippetsDir
  dependsOn junitPlatformTest  
}

或

asciidoctor {
  attributes "snippets": snippetsDir
  dependsOn junitPlatformTest  
}

工作 Gradle 设置的示例：

Spring REST Docs - how to configure asciidoctor task to include generated snippet into index?