Skip to content

Commit 9c97c8b

Browse files
committed
Polish "Improve documention on how to use .adoc snippets"
See gh-279
1 parent eb46eaa commit 9c97c8b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/src/docs/asciidoc/getting-started.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -419,26 +419,27 @@ that can be produced by Spring REST Docs.
419419
[[getting-started-using-the-snippets]]
420420
=== Using the snippets
421421

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.
422+
Before using the generated snippets, a `.adoc` source file must be created. You can name
423+
the file whatever you like as long as it has a `.adoc` suffix. The result HTML file will
424+
have the same name but with a `.html` suffix. The default location of the source files and
425+
the resulting HTML files depends on whether you are using Maven or Gradle:
426426

427427
[cols="2,5,8"]
428428
|===
429429
| Build tool | Source files | Generated files
430430

431431
| Maven
432-
| ```src/main/asciidoc/*.adoc```
433-
| ```${project.build.directory}/generated-docs/*.html```
432+
| `src/main/asciidoc/*.adoc`
433+
| `target/generated-docs/*.html`
434434

435435
| Gradle
436-
| ```src/docs/asciidoc/*.adoc```
437-
| ```$buildDir/asciidoc/*.html```
436+
| `src/docs/asciidoc/*.adoc`
437+
| `build/asciidoc/html5/*.html`
438438

439439
|===
440440

441-
The generated snippets can then be included in the manually created Asciidoctor file from above using the
441+
The generated snippets can then be included in the manually created Asciidoctor file from
442+
above using the
442443
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
443444
The `snippets` attribute specified in the <<getting-started-build-configuration, build
444445
configuration>> can be used to reference the snippets output directory. For example:

0 commit comments

Comments
 (0)