Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish "Improve documention on how to use .adoc snippets"

Browse Source 
See gh-279
This commit is contained in:
Andy Wilkinson
2016-07-22 10:45:14 +01:00
parent eb46eaa3c5
commit 9c97c8b9bf
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -419,26 +419,27 @@ that can be produced by Spring REST Docs.
[[getting-started-using-the-snippets]]
=== Using the snippets
Before using the generated snippets from above, an ```\*.adoc``` source file must be manually created.
Its filename does not matter for either of the two build tools' Asciidoctor plugins mentioned
above and will also be the name of the finally generated ```*.html``` file.
For the exact locations refer to the following table.
Before using the generated snippets, a `.adoc` source file must be created. You can name
the file whatever you like as long as it has a `.adoc` suffix. The result HTML file will
have the same name but with a `.html` suffix. The default location of the source files and
the resulting HTML files depends on whether you are using Maven or Gradle:
[cols="2,5,8"]
|===
| Build tool | Source files | Generated files
| Maven
| ```src/main/asciidoc/*.adoc```
| ```${project.build.directory}/generated-docs/*.html```
| `src/main/asciidoc/*.adoc`
| `target/generated-docs/*.html`
| Gradle
| ```src/docs/asciidoc/*.adoc```
| ```$buildDir/asciidoc/*.html```
| `src/docs/asciidoc/*.adoc`
| `build/asciidoc/html5/*.html`
|===
The generated snippets can then be included in the manually created Asciidoctor file from above using the
The generated snippets can then be included in the manually created Asciidoctor file from
above using the
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
The `snippets` attribute specified in the <<getting-started-build-configuration, build
configuration>> can be used to reference the snippets output directory. For example: