File tree Expand file tree Collapse file tree 1 file changed +20
-1
lines changed Expand file tree Collapse file tree 1 file changed +20
-1
lines changed Original file line number Diff line number Diff line change @@ -419,7 +419,26 @@ that can be produced by Spring REST Docs.
419419[[getting-started-using-the-snippets]]
420420=== Using the snippets
421421
422- The generated snippets can be included in your documentation using the
422+ Before using the generated snippets from above, an ```\*.adoc``` source file must be manually created.
423+ Its filename does not matter for either of the two build tools' Asciidoctor plugins mentioned
424+ above and will also be the name of the finally generated ```*.html``` file.
425+ For the exact locations refer to the following table.
426+
427+ [cols="2,5,8"]
428+ |===
429+ | Build tool | Source files | Generated files
430+
431+ | Maven
432+ | ```src/main/asciidoc/*.adoc```
433+ | ```${project.build.directory}/generated-docs/*.html```
434+
435+ | Gradle
436+ | ```src/docs/asciidoc/*.adoc```
437+ | ```$buildDir/asciidoc/*.html```
438+
439+ |===
440+
441+ The generated snippets can then be included in the manually created Asciidoctor file from above using the
423442http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
424443The `snippets` attribute specified in the <<getting-started-build-configuration, build
425444configuration>> can be used to reference the snippets output directory. For example:
You can’t perform that action at this time.
0 commit comments