diff --git a/README.md b/README.md index 30d4cca9..d61d201b 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,15 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail ## Documentation -[Current 2.0.0 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.0/docs/index.html) reference guide (based on Spring REST Docs 2.x). +[Current 2.0.1 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.1/docs/index.html) reference guide (based on Spring REST Docs 2.x). -[Current 1.0.12 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.12/docs/index.html) reference guide (based on Spring REST Docs 1.x). +[Current 1.0.13 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.13/docs/index.html) reference guide (based on Spring REST Docs 1.x). -Latest master [2.0.1-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide. +Latest master [2.0.2-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide. -Older releases: +Older releases: +[2.0.0](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.0/docs/index.html), +[1.0.12](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.12/docs/index.html), [1.0.11](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.11/docs/index.html), [1.0.10](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.10/docs/index.html), [1.0.9](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.9/docs/index.html), diff --git a/docs/index.html b/docs/index.html index abd8c120..bfe2300c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -432,7 +432,7 @@
<dependency>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-core</artifactId>
- <version>2.0.0</version>
+ <version>2.0.1</version>
<scope>test</scope> (1)
</dependency>
@@ -639,7 +639,7 @@ Usage
<docletArtifact>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-json-doclet</artifactId>
- <version>2.0.0</version>
+ <version>2.0.1</version>
</docletArtifact>
<destDir>generated-javadoc-json</destDir> (3)
<reportOutputDirectory>${project.build.directory}</reportOutputDirectory> (3)
@@ -684,8 +684,8 @@ Usage
}
dependencies {
- testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.0' (1)
- jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.0'
+ testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.1' (1)
+ jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.1'
}
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1235,6 +1235,18 @@ Configuration
+ + | ++Section snippets only work if AsciiDoc is used. Markdown is not supported, because Markdown has no includes. + | +
The section snippet combines most common snippets into one convenient file. It helps you being even more lazy, because a single line of AsciiDoc is sufficient to document one endpoint. @@ -1252,14 +1264,14 @@
[[resources-{{link}}]]
=== {{title}}
-include::{snippets}/{{path}}/auto-method-path.adoc[]
+include::auto-method-path.adoc[]
-include::{snippets}/{{path}}/auto-description.adoc[]
+include::auto-description.adoc[]
{{#sections}}
==== {{header}}
-include::{snippets}/{{path}}/{{fileName}}.adoc[]
+include::{{fileName}}.adoc[]
{{/sections}}