You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
YuCheng Hu 5f87958746
Merge pull request #2 from ossez-com/docs_update
2 years ago
ci Upgrade CI image and add missing python dependency 2 years ago
gradle/wrapper Upgrade to Gradle 6.6.1 2 years ago
spring-style-guide URL Cleanup (#10) 3 years ago
src 修改使用语法高亮的 JS 代码和版本,更新到最新的版本 2 years ago
.gitignore Generate Asciidoctor theme from source files 4 years ago
LICENSE.txt URL Cleanup (#11) 3 years ago Fix maven asciidoctor sample configuration 2 years ago
build.gradle 更新版本测试连通性 2 years ago Next development version (v0.2.6-SNAPSHOT) 2 years ago
gradlew Upgrade to Gradle 6.6.1 2 years ago
gradlew.bat Upgrade to Gradle 6.6.1 2 years ago
gulpfile.js Fix missing highlightJS stylesheets 2 years ago
package.json 针对 Node 修改 json 的配置文件 2 years ago
settings.gradle 项目是从 spring Doc 项目中 fork 来的,修改名字用于 OSSEZ 项目的文档样式 2 years ago

Spring Doc Resources

This project generates and packages the static resources that Spring uses for document production.

Maven build integration

You can use the Asciidoctor Maven plugin to generate your documentation.

Unpack the resources and the actual Asciidoc documents in a specific build directory:


Finally, launch the documentation generation process (the default output location is target/generated-docs/):

			// Add attributes generated by the build
			// Add locations of code snippets to include in the documentation
					// these attributes are required to use the doc resources

Gradle build integration

You can use the Asciidoctor Gradle plugin to generate your documentation.

// declare a configuration for documentation resources
configurations {

dependencies {
	docs "io.spring.docresources:spring-doc-resources:${docResourcesVersion}@zip"

task prepareAsciidocBuild(type: Sync) {
	// copy doc resources
	from { { zipTree(it) }
	// and doc sources
	from "src/docs/asciidoc/"
	// to a build directory of your choice
	into "$buildDir/asciidoc/build"

task('makePDF', type: org.asciidoctor.gradle.AsciidoctorTask){
	dependsOn prepareAsciidocBuild
	backends 'pdf'
	sourceDir "$buildDir/asciidoc/assemble"
	sources {
		include 'index-test.adoc'
		include 'test.adoc'
	options doctype: 'book', eruby: 'erubis'
	logDocuments = true
	attributes 'icons': 'font',
		'sectanchors': '',
		'toc': '',
		'source-highlighter' : 'coderay'

asciidoctor {
	// run asciidoctor from that directory
	sourceDir "$buildDir/asciidoc/build"
	sources {
		include '*.adoc'
	resources {
		from(sourceDir) {
			include 'images/*', 'css/**', 'js/**'
	logDocuments = true
	backends = ["html5"]
	options doctype: 'book', eruby: 'erubis'
	attributes  'docinfo': 'shared',
		// use provided stylesheet
		stylesdir: "css/",
		stylesheet: 'spring.css',
		'linkcss': true,
		'icons': 'font',
		// use provided highlighter

asciidoctor.dependsOn makePDF


spring-doc-resources has a few features that we have added to address certain use cases.

For HTML output, if the current page is not index.html, you automatically get a link to index.html. This link appears above the table of contents. For many projects, this link never appears, because that project's build renders the documentation as index.html.

You can customize the destination of the "Back to Index" link by specifying a role with a value of #index-link, as follows:


where is the link you want.

Please do use a link that readers might reasonably think would be an index page. (The canonical case is the project's page on

Nominally, you can put that role anywhere, but near the top of your main Asciidoc file makes the most sense.


As with anything, there are some limitations that you should be aware of when you use spring-doc-resources.

Code samples

When including code samples in the documentation, their location must not rely on relative paths, as the actual documentation build happens within the build/target folder. To work around that limitation, the build should introduce an attribute pointing to a particular location within project sources, from which code samples can be resolved.

DocInfo files

To get the dynamic table of contents to work correctly, you need to set the docinfo attribute to shared, thus: :docinfo: shared. Bear in mind that, if you set the attribute in your build, it overrides the value in your Asciidoc files. You may still want to set the attribute in your Asciidoc files, though, if you generate files with the asciidoctor command for testing. You can also use private docinfo particular to asciidoc documents (see docinfo documentation).

Distribution Zip

The final distribution zip file contains the following:

|- docinfo.html, docinfo-footer.html (shared docinfo HTML files)
|- css/** (stylesheets)
|– js
   |- tocbot/** (navigation in table of contents)
   |- highlight/** (code highlighting)

You should unzip the whole archive at the top of your Asciidoc hierarchy (typically src/main/asciidoc and typically in the same directory as index.adoc).

CAUTION: You cannot let Asciidoctor generate its output and then move the files. The files have to be in position when Asciidoctor runs.

Doc Resources

This project contains the following:

  • /src/main/sass/**: The stylesheet for the HTML versions of the Spring reference guides, generated from SASS files.
  • /src/main/resources/js/**: Javascript libraries for the Table of Contents and code hilighting.
  • /src/main/resources/*.html: The custom Asciidoctor docinfo files.
  • build.gradle: The Gradle build file for this project.
  • gulpfile.js: The Gulp build that compiles sources into static files
  • package.json: The dependencies for the NPM-based build
  • This file.

Building the project

Running ./gradlew distZip will build and package the asciidoctor theme in a zip file in build/distributions. You can also publish that artifact to your local maven repository for testing with ./gradlew publishToMavenLocal.

When working on the project, one can run the following command:

$ ./gradlew npm_run_dev

This will start a local server on http://localhost:8080, watch files under src/** and rebuild automatically. Please consider installing the Livereload browser extension for a better experience.

You can also install the Gulp CLI and directly run build commands:

$ npm i -g gulp-cli
$ gulp dev