Move to pure Asciidoctor for documentation

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -1,6 +1,9 @@
 :numbered!:
 [appendix]
 [[common-application-properties]]
+
+include::attributes.adoc[]
+
 == Common application properties
 Various properties can be specified inside your `application.properties` file, inside
 your `application.yml` file, or as command line switches. This appendix provides a list

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-auto-configuration-classes.adoc

@@ -1,6 +1,9 @@
 [appendix]
 [[auto-configuration-classes]]
 == Auto-configuration classes
+
+include::attributes.adoc[]
+
 Here is a list of all auto-configuration classes provided by Spring Boot, with links to
 documentation and source code. Remember to also look at the conditions report in your
 application for more details of which features are switched on.

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc

@@ -1,6 +1,9 @@
 [appendix]
 [[configuration-metadata]]
 == Configuration Metadata
+
+include::attributes.adoc[]
+
 Spring Boot jars include metadata files that provide details of all supported
 configuration properties. The files are designed to let IDE developers offer
 contextual help and "`code completion`" as users are working with `application.properties`

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-dependency-versions.adoc

@@ -6,4 +6,4 @@ by Spring Boot in its CLI (Command Line Interface), Maven dependency management,
 Gradle plugin. When you declare a dependency on one of these artifacts without declaring
 a version, the version listed in the table is used.
 
-include::../../../target/generated-resources/effective-pom.adoc[]
+include::../../../target/generated-resources/effective-pom.adoc[]

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-executable-jar-format.adoc

@@ -1,6 +1,9 @@
 [appendix]
 [[executable-jar]]
 == The Executable Jar Format
+
+include::attributes.adoc[]
+
 The `spring-boot-loader` modules lets Spring Boot support executable jar and
 war files. If you use the Maven plugin or the Gradle plugin, executable jars are
 automatically generated, and you generally do not need to know the details of how
@@ -331,4 +334,3 @@ following alternatives:
 * https://maven.apache.org/plugins/maven-shade-plugin/[Maven Shade Plugin]
 * http://www.jdotsoft.com/JarClassLoader.php[JarClassLoader]
 * http://one-jar.sourceforge.net[OneJar]
-

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-test-auto-configuration.adoc

@@ -1,7 +1,8 @@
 [appendix]
 [[test-auto-configuration]]
-== Test auto-configuration annotations
+== Test Auto-configuration Annotations
+
 The following table lists the various `@…Test` annotations that can be used to test
 slices of your application and the auto-configuration that they import by default:
 
-include::../../../target/generated-resources/test-slice-auto-configuration.adoc[]
+include::../../../target/generated-resources/test-slice-auto-configuration.adoc[]

spring-boot-project/spring-boot-docs/src/main/asciidoc/attributes.adoc

@@ -0,0 +1,65 @@
+:spring-boot-repo: snapshot
+:github-tag: master
+:spring-boot-docs-version: current
+:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference
+:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference
+:github-repo: spring-projects/spring-boot
+:github-raw: https://raw.github.com/{github-repo}/{github-tag}
+:github-code: https://github.com/{github-repo}/tree/{github-tag}
+:github-issues: https://github.com/{github-repo}/issues/
+:github-wiki: https://github.com/{github-repo}/wiki
+:github-master-code: https://github.com/{github-repo}/tree/master
+:sc-ext: java
+:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot
+:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure
+:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate
+:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure
+:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli
+:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools
+:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test
+:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure
+:dc-ext: html
+:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api
+:dc-spring-boot: {dc-root}/org/springframework/boot
+:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure
+:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate
+:dc-spring-boot-test: {dc-root}/org/springframework/boot/test
+:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure
+:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin
+:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md
+:java-javadoc: https://docs.oracle.com/javase/8/docs/api/
+:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/
+:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin
+:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin
+:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html
+:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/
+:spring-rest-docs: https://projects.spring.io/spring-restdocs/
+:spring-integration: https://projects.spring.io/spring-integration/
+:spring-session: https://projects.spring.io/spring-session/
+:spring-framework: http://projects.spring.io/spring-framework/
+:spring-security: http://projects.spring.io/spring-security/
+:spring-data-jpa: http://projects.spring.io/spring-data-jpa/
+:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle
+:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html
+:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/
+:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework
+:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp
+:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch
+:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa
+:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data
+:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb
+:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/
+:spring-data: https://projects.spring.io/spring-data/
+:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest
+:gradle-userguide: https://www.gradle.org/docs/current/userguide
+:ant-manual: http://ant.apache.org/manual
+:code-examples: ../java/org/springframework/boot/docs
+:test-examples: ../../test/java/org/springframework/boot/docs
+:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide
+:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html
+:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x
+:micrometer-concepts-documentation: https://micrometer.io/docs/concepts
+:micrometer-registry-documentation: http://micrometer.io/docs/registry
+:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc
+:kotlin-documentation: https://kotlinlang.org/docs/reference/
+:junit5-documentation: https://junit.org/junit5/docs/current/user-guide

spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc

@@ -1,5 +1,7 @@
 [[build-tool-plugins]]
-= Build tool plugins
+= Build Tool Plugins
+
+include::attributes.adoc[]
 
 [partintro]
 --

spring-boot-project/spring-boot-docs/src/main/asciidoc/colophon.adoc

@@ -0,0 +1,11 @@
+[colophon]
+= Colophon
+
+{spring-boot-version}
+
+Copyright © 2012-2018
+
+Copies of this document may be made for your own use and for distribution to
+others, provided that you do not charge any fee for such copies and further
+provided that each copy contains this Copyright Notice, whether distributed in
+print or electronically.

spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc

@@ -1,6 +1,8 @@
 [[deployment]]
 = Deploying Spring Boot Applications
 
+include::attributes.adoc[]
+
 [partintro]
 --
 Spring Boot's flexible packaging options provide a great deal of choice when it comes to

spring-boot-project/spring-boot-docs/src/main/asciidoc/docinfo-footer.html

@@ -0,0 +1,51 @@
+<script type="text/javascript" src="tocbot-3.0.2/tocbot.js"></script>
+<script type="text/javascript" >
+
+    // Tocbot dynamic TOC, works with tocbot 3.0.2
+    // Source: https://github.com/asciidoctor/asciidoctor/issues/699#issuecomment-321066006
+
+    var oldtoc = document.getElementById('toctitle').nextElementSibling;
+    var newtoc = document.createElement('div');
+    newtoc.setAttribute('id', 'tocbot');
+    newtoc.setAttribute('class', 'js-toc');
+    oldtoc.parentNode.replaceChild(newtoc, oldtoc);
+    tocbot.init({ contentSelector: '#content',
+        headingSelector: 'h1, h2, h3, h4, h5',
+        smoothScroll: false });
+    var handleTocRefresh = function() {
+        tocbot.refresh();
+    }
+    var handleTocOnResize = function() {
+        var width = window.innerWidth
+                    || document.documentElement.clientWidth
+                    || document.body.clientWidth;
+        if (width < 768) {
+            tocbot.refresh({ contentSelector: '#content',
+                headingSelector: 'h1, h2, h3, h4, h5',
+                collapseDepth: 6,
+                activeLinkClass: 'ignoreactive',
+                throttleTimeout: 1000,
+                smoothScroll: false });
+        }
+        else {
+            tocbot.refresh({ contentSelector: '#content',
+                headingSelector: 'h1, h2, h3, h4, h5',
+                smoothScroll: false });
+        }
+    };
+    window.addEventListener('resize', handleTocOnResize);
+    window.addEventListener('tocRefresh', handleTocRefresh);
+    handleTocOnResize();
+
+    if (!window.location.pathname.endsWith("index.html")) {
+        var link = document.createElement("a");
+        link.setAttribute("href", "index.html");
+        link.innerHTML = "<i class=\"fa fa-chevron-left\"></i>&nbsp;&nbsp;Back to index";
+        var p = document.createElement("p");
+        p.setAttribute("id", "backToIndex");
+        p.appendChild(link);
+        var toc = document.getElementById('toc')
+        toc.insertBefore(p, toctitle);
+  }
+
+</script>

spring-boot-project/spring-boot-docs/src/main/asciidoc/docinfo.html

@@ -0,0 +1,15 @@
+<style>
+  #tocbot a.toc-link.node-name--H1{ font-style: italic }
+  @media screen{
+    #tocbot > ul.toc-list{ margin-bottom: 0.5em; margin-left: 0.125em }
+    #tocbot ul.sectlevel0, #tocbot a.toc-link.node-name--H1 + ul{
+      padding-left: 0 }
+    #tocbot a.toc-link{ height:100% }
+    .is-collapsible{ max-height:3000px; overflow:hidden; }
+    .is-collapsed{ max-height:0 }
+    .is-active-link{ font-weight:700 }
+  }
+  @media print{
+    #tocbot a.toc-link.node-name--H4{ display:none }
+  }
+</style>

spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

@@ -1,6 +1,8 @@
 [[boot-documentation]]
 = Spring Boot Documentation
 
+include::attributes.adoc[]
+
 [partintro]
 --
 This section provides a brief overview of Spring Boot reference documentation. It serves
@@ -152,4 +154,3 @@ Properties>> |
 <<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration
 classes>> |
 <<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>>
-

spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc

@@ -1,6 +1,8 @@
 [[getting-started]]
 = Getting Started
 
+include::attributes.adoc[]
+
 [partintro]
 --
 If you are getting started with Spring Boot, or "`Spring`" in general, start by reading
@@ -627,7 +629,7 @@ important parts in the next few sections.
 
 
 [[getting-started-first-application-annotations]]
-==== The @RestController and @RequestMapping Annotations
+==== The `@RestController` and `@RequestMapping` Annotations
 The first annotation on our `Example` class is `@RestController`. This is known as a
 _stereotype_ annotation. It provides hints for people reading the code and for Spring
 that the class plays a specific role. In this case, our class is a web `@Controller`, so

spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc

@@ -1,5 +1,9 @@
+:code-examples: ../java/org/springframework/boot
+
 [[howto]]
-= '`How-to`' guides
+= "`How-to`" Guides
+
+include::attributes.adoc[]
 
 [partintro]
 --