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

Merge pull request #279 from mle-enso

Browse Source 
* gh-279:
  Polish "Improve documention on how to use .adoc snippets"
  Improve documention on how to use .adoc snippets
This commit is contained in:
Andy Wilkinson
2016-07-22 10:56:32 +01:00
parent f77864b094 9c97c8b9bf
commit 6131730621
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -419,7 +419,27 @@ that can be produced by Spring REST Docs.
[[getting-started-using-the-snippets]]
=== Using the snippets
The generated snippets can be included in your documentation using the
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`
| `target/generated-docs/*.html`
| Gradle
| `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
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: