Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
1e0cf960
Commit
1e0cf960
authored
Jun 18, 2019
by
Phillip Webb
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Reinstate single page HTML and PDF docs
Closes gh-16854
parent
e44caec6
Changes
9
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
88 additions
and
23 deletions
+88
-23
pom.xml
spring-boot-project/spring-boot-docs/pom.xml
+60
-1
documentation-overview.adoc
...g-boot-docs/src/main/asciidoc/documentation-overview.adoc
+6
-4
epub-cover.png
.../spring-boot-docs/src/main/asciidoc/images/epub-cover.png
+0
-0
epub-cover.svg
.../spring-boot-docs/src/main/asciidoc/images/epub-cover.svg
+0
-13
index.htmladoc
...project/spring-boot-docs/src/main/asciidoc/index.htmladoc
+0
-0
index.htmlsingleadoc
...t/spring-boot-docs/src/main/asciidoc/index.htmlsingleadoc
+0
-0
spring-boot-reference.pdfadoc
...boot-docs/src/main/asciidoc/spring-boot-reference.pdfadoc
+17
-0
pom.xml
spring-boot-project/spring-boot-parent/pom.xml
+5
-0
pom.xml
...oject/spring-boot-tools/spring-boot-gradle-plugin/pom.xml
+0
-5
No files found.
spring-boot-project/spring-boot-docs/pom.xml
View file @
1e0cf960
...
@@ -1442,7 +1442,14 @@
...
@@ -1442,7 +1442,14 @@
<artifactId>
asciidoctor-maven-plugin
</artifactId>
<artifactId>
asciidoctor-maven-plugin
</artifactId>
<configuration>
<configuration>
<sourceDirectory>
${refdocs.build.directory}
</sourceDirectory>
<sourceDirectory>
${refdocs.build.directory}
</sourceDirectory>
<outputDirectory>
${project.build.directory}/generated-docs/reference/html
</outputDirectory>
<resources>
<resource>
<directory>
${refdocs.build.directory}
</directory>
<excludes>
<exclude>
**/*.*adoc
</exclude>
</excludes>
</resource>
</resources>
<attributes>
<attributes>
<spring-boot-docs-version>
${revision}
</spring-boot-docs-version>
<spring-boot-docs-version>
${revision}
</spring-boot-docs-version>
<spring-boot-repo>
${spring-boot-repo}
</spring-boot-repo>
<spring-boot-repo>
${spring-boot-repo}
</spring-boot-repo>
...
@@ -1465,6 +1472,11 @@
...
@@ -1465,6 +1472,11 @@
</goals>
</goals>
<configuration>
<configuration>
<backend>
html5
</backend>
<backend>
html5
</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>
adoc
</sourceDocumentExtension>
<sourceDocumentExtension>
htmladoc
</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>
${project.build.directory}/generated-docs/reference/html
</outputDirectory>
<sourceHighlighter>
highlight.js
</sourceHighlighter>
<sourceHighlighter>
highlight.js
</sourceHighlighter>
<doctype>
book
</doctype>
<doctype>
book
</doctype>
<attributes>
<attributes>
...
@@ -1478,6 +1490,53 @@
...
@@ -1478,6 +1490,53 @@
</attributes>
</attributes>
</configuration>
</configuration>
</execution>
</execution>
<execution>
<id>
generate-htmlsingle-documentation
</id>
<phase>
prepare-package
</phase>
<goals>
<goal>
process-asciidoc
</goal>
</goals>
<configuration>
<backend>
html5
</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>
htmlsingleadoc
</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>
${project.build.directory}/generated-docs/reference/htmlsingle
</outputDirectory>
<sourceHighlighter>
highlight.js
</sourceHighlighter>
<doctype>
book
</doctype>
<attributes>
<highlightjsdir>
js/highlight
</highlightjsdir>
<highlightjs-theme>
atom-one-dark-reasonable
</highlightjs-theme>
<linkcss>
true
</linkcss>
<imagesdir>
./images
</imagesdir>
<icons>
font
</icons>
<stylesdir>
css/
</stylesdir>
<stylesheet>
spring.css
</stylesheet>
</attributes>
</configuration>
</execution>
<execution>
<id>
generate-pdf-documentation
</id>
<phase>
prepare-package
</phase>
<goals>
<goal>
process-asciidoc
</goal>
</goals>
<configuration>
<backend>
pdf
</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>
pdfadoc
</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>
${project.build.directory}/generated-docs/reference/pdf
</outputDirectory>
<resources>
<resource>
<directory>
${refdocs.build.directory}
</directory>
<excludes>
<exclude>
**/*
</exclude>
</excludes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</executions>
</plugin>
</plugin>
<plugin>
<plugin>
...
...
spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc
View file @
1e0cf960
...
@@ -13,10 +13,12 @@ as a map for the rest of the document.
...
@@ -13,10 +13,12 @@ as a map for the rest of the document.
[[boot-documentation-about]]
[[boot-documentation-about]]
== About the Documentation
== About the Documentation
The Spring Boot reference guide is available as
The Spring Boot reference guide is available as
<<single-index.adoc#spring-boot-reference-documentation, single page>> or
<<index.adoc#spring-boot-reference-documentation, multi-page>> documentation.
* {spring-boot-docs}/html[Multi-page HTML]
The latest copy
* {spring-boot-docs}/htmlsingle[Single page HTML]
of the reference documentation is available at {spring-boot-docs-current}.
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
The latest copy is available at {spring-boot-docs-current}.
Copies of this document may be made for your own use and for distribution to others,
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
provided that you do not charge any fee for such copies and further provided that each
...
...
spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.png
deleted
100644 → 0
View file @
e44caec6
74.3 KB
spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.svg
deleted
100644 → 0
View file @
e44caec6
This diff is collapsed.
Click to expand it.
spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc
→
spring-boot-project/spring-boot-docs/src/main/asciidoc/index.
html
adoc
View file @
1e0cf960
File moved
spring-boot-project/spring-boot-docs/src/main/asciidoc/
single-index.
adoc
→
spring-boot-project/spring-boot-docs/src/main/asciidoc/
index.htmlsingle
adoc
View file @
1e0cf960
File moved
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-reference.pdfadoc
0 → 100644
View file @
1e0cf960
[[spring-boot-reference-documentation]]
= Spring Boot Reference Documentation
Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons, Vedran Pavić, Jay Bryant, Madhura Bhave
:docinfo: shared
include::attributes.adoc[]
include::legal.adoc[leveloffset=+1]
include::documentation-overview.adoc[leveloffset=+1]
include::getting-started.adoc[leveloffset=+1]
include::using-spring-boot.adoc[leveloffset=+1]
include::spring-boot-features.adoc[leveloffset=+1]
include::production-ready-features.adoc[leveloffset=+1]
include::deployment.adoc[leveloffset=+1]
include::spring-boot-cli.adoc[leveloffset=+1]
include::build-tool-plugins.adoc[leveloffset=+1]
include::howto.adoc[leveloffset=+1]
include::appendix.adoc[leveloffset=+1]
spring-boot-project/spring-boot-parent/pom.xml
View file @
1e0cf960
...
@@ -306,6 +306,11 @@
...
@@ -306,6 +306,11 @@
<artifactId>
asciidoctorj
</artifactId>
<artifactId>
asciidoctorj
</artifactId>
<version>
1.5.8
</version>
<version>
1.5.8
</version>
</dependency>
</dependency>
<dependency>
<groupId>
org.asciidoctor
</groupId>
<artifactId>
asciidoctorj-pdf
</artifactId>
<version>
1.5.0-alpha.11
</version>
</dependency>
</dependencies>
</dependencies>
</plugin>
</plugin>
<plugin>
<plugin>
...
...
spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/pom.xml
View file @
1e0cf960
...
@@ -356,11 +356,6 @@
...
@@ -356,11 +356,6 @@
</attributes>
</attributes>
</configuration>
</configuration>
<dependencies>
<dependencies>
<dependency>
<groupId>
org.asciidoctor
</groupId>
<artifactId>
asciidoctorj-pdf
</artifactId>
<version>
1.5.0-alpha.11
</version>
</dependency>
<dependency>
<dependency>
<groupId>
io.spring.asciidoctor
</groupId>
<groupId>
io.spring.asciidoctor
</groupId>
<artifactId>
spring-asciidoctor-extensions
</artifactId>
<artifactId>
spring-asciidoctor-extensions
</artifactId>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment