Update doc appearance and link doc formats
Updated the ToC, banner, highlighting, and CSS styles to the last Spring standard. Linked the HTML output to the PDF output and vice-versa.
This commit is contained in:
Jay Bryant
committed by
Janne Valkealahti
Janne Valkealahti
parent
58410d2f7b
commit
eca0dd1572
@@ -11,13 +11,13 @@
|
||||
<artifactId>spring-shell-parent</artifactId>
|
||||
<version>3.0.0.BUILD-SNAPSHOT</version>
|
||||
</parent>
|
||||
|
||||
|
||||
<description>Spring Shell reference documentation</description>
|
||||
<properties>
|
||||
<asciidoctor.maven.plugin.version>1.5.5</asciidoctor.maven.plugin.version>
|
||||
<asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
|
||||
<asciidoctorj.version>1.5.6</asciidoctorj.version>
|
||||
<jruby.version>1.7.26</jruby.version>
|
||||
<asciidoctor.maven.plugin.version>2.1.0</asciidoctor.maven.plugin.version>
|
||||
<asciidoctorj.pdf.version>1.5.4</asciidoctorj.pdf.version>
|
||||
<asciidoctorj.version>2.5.1</asciidoctorj.version>
|
||||
<spring-doc-resources.version>0.2.5</spring-doc-resources.version>
|
||||
</properties>
|
||||
|
||||
<!-- This project artificially depends on all others so that the javadoc plugin can consolidate everything.-->
|
||||
@@ -55,7 +55,51 @@
|
||||
</dependencies>
|
||||
<build>
|
||||
<plugins>
|
||||
<!-- doc resources -->
|
||||
<plugin>
|
||||
<groupId>com.googlecode.maven-download-plugin</groupId>
|
||||
<artifactId>download-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>unpack-doc-resources</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>wget</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<url>https://repo.spring.io/release/io/spring/docresources/spring-doc-resources/${spring-doc-resources.version}/spring-doc-resources-${spring-doc-resources.version}.zip</url>
|
||||
<unpack>true</unpack>
|
||||
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-asciidoc-resources</id>
|
||||
<phase>generate-resources</phase>
|
||||
<inherited>false</inherited>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/asciidoc</directory>
|
||||
<filtering>false</filtering>
|
||||
</resource>
|
||||
</resources>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
<!-- ASCIIDOC -->
|
||||
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
@@ -66,62 +110,65 @@
|
||||
<artifactId>asciidoctorj-pdf</artifactId>
|
||||
<version>${asciidoctorj.pdf.version}</version>
|
||||
</dependency>
|
||||
<!-- Comment this section to use the default jruby artifact provided by the plugin -->
|
||||
<dependency>
|
||||
<groupId>org.jruby</groupId>
|
||||
<artifactId>jruby-complete</artifactId>
|
||||
<version>${jruby.version}</version>
|
||||
</dependency>
|
||||
<!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
|
||||
<dependency>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctorj</artifactId>
|
||||
<version>${asciidoctorj.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<configuration>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<doctype>book</doctype>
|
||||
<attributes>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
<attribute-missing>warn</attribute-missing>
|
||||
<project-version>${project.version}</project-version>
|
||||
<project-artifactId>${project.artifactId}</project-artifactId>
|
||||
</attributes>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-html5</id>
|
||||
<phase>prepare-package</phase>
|
||||
<id>html</id>
|
||||
<phase>generate-resources</phase>
|
||||
<inherited>false</inherited>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>html5</backend>
|
||||
<outputDirectory>${project.build.directory}/site/reference/html</outputDirectory>
|
||||
<sourceHighlighter>highlight.js</sourceHighlighter>
|
||||
<attributes>
|
||||
<toc2 />
|
||||
<docinfo>shared-head</docinfo>
|
||||
<source-highlighter>coderay</source-highlighter>
|
||||
// these attributes are required to use the doc resources
|
||||
<docinfo>shared</docinfo>
|
||||
<stylesdir>css/</stylesdir>
|
||||
<stylesheet>spring.css</stylesheet>
|
||||
<linkcss>true</linkcss>
|
||||
<icons>font</icons>
|
||||
<highlightjsdir>js/highlight</highlightjsdir>
|
||||
<highlightjs-theme>github</highlightjs-theme>
|
||||
<sectanchors>true</sectanchors>
|
||||
</attributes>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
<execution>
|
||||
<id>generate-pdf</id>
|
||||
<phase>prepare-package</phase>
|
||||
<id>pdf</id>
|
||||
<phase>generate-resources</phase>
|
||||
<inherited>false</inherited>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<outputDirectory>${project.build.directory}/site/reference/pdf</outputDirectory>
|
||||
<backend>pdf</backend>
|
||||
<sourceHighlighter>coderay</sourceHighlighter>
|
||||
<attributes>
|
||||
<toc />
|
||||
<pagenums />
|
||||
</attributes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
|
||||
<configuration>
|
||||
<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<doctype>book</doctype>
|
||||
<attributes>
|
||||
<version>${project.version}</version>
|
||||
<projectName>${project.name}</projectName>
|
||||
<projectVersion>${project.version}</projectVersion>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
<toclevels>4</toclevels>
|
||||
<numbered>true</numbered>
|
||||
<baseDir>${project.basedir}</baseDir>
|
||||
</attributes>
|
||||
</configuration>
|
||||
|
||||
</plugin>
|
||||
|
||||
<!-- API DOCS -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
|
||||
@@ -8,15 +8,16 @@
|
||||
<includeBaseDirectory>false</includeBaseDirectory>
|
||||
<fileSets>
|
||||
<fileSet>
|
||||
<directory>${project.build.directory}/generated-docs</directory>
|
||||
<outputDirectory>reference/htmlsingle</outputDirectory>
|
||||
<directory>${project.build.directory}/site/reference/html</directory>
|
||||
<outputDirectory>site/reference/htmlsingle</outputDirectory>
|
||||
<includes>
|
||||
<include>index.html</include>
|
||||
<include>**/*</include>
|
||||
</includes>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>${project.build.directory}/generated-docs</directory>
|
||||
<outputDirectory>reference/pdf</outputDirectory>
|
||||
<directory>${project.build.directory}/site/reference/pdf</directory>
|
||||
<outputDirectory>site/reference/pdf</outputDirectory>
|
||||
<includes>
|
||||
<include>index.pdf</include>
|
||||
</includes>
|
||||
@@ -26,4 +27,4 @@
|
||||
<outputDirectory>api</outputDirectory>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
</assembly>
|
||||
</assembly>
|
||||
|
||||
@@ -5,7 +5,15 @@ Eric Bottard;
|
||||
:icons: font
|
||||
:experimental: // For kbd: macro
|
||||
|
||||
Version {project-version}
|
||||
ifdef::backend-html5[]
|
||||
*{projectVersion}*
|
||||
|
||||
NOTE: This documentation is also available as https://docs.spring.io/spring-shell/docs/{projectVersion}/reference/pdf/index.pdf[PDF].
|
||||
endif::[]
|
||||
|
||||
ifdef::backend-pdf[]
|
||||
NOTE: This documentation is also available as https://docs.spring.io/spring-shell/docs/{projectVersion}/reference/htmlsingle/index.html[HTML].
|
||||
endif::[]
|
||||
|
||||
(C) 2017 Pivotal Software, Inc.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user