SpringCloud/spring-cloud-release
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Antora

Browse Source
This commit is contained in:
Marcin Grzejszczak
2023-09-14 18:07:22 +02:00
parent 8035dcc4b8
commit e2ea9313cf
11 changed files with 832 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.adoc Normal file
View File

@@ -0,0 +1,23 @@
= Spring Cloud Release Docs Build
You're currently viewing the Antora playbook branch.
The playbook branch hosts the docs build that is used to build and publish the production docs site.
The Spring Cloud Release reference docs are built using https://antora.org[Antora].
This README covers how to build the docs in a software branch as well as how to build the production docs site locally.
== Building the Site
You can build the entire site by invoking the following on the docs-build branch and then viewing the site at `target/site/index.html`
[source,bash]
----
mvn antora
----
== Building a Specific Branch
[source,bash]
----
mvn antora
----