Common classes used in different Spring Cloud implementations
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.
Olga MaciaszekSharma 2830279fa2 Fix tag wildcards. 1 year ago
.github/workflows Update deploy-docs.yml 1 year ago
.mvn Initial commit 1 year ago
supplemental-ui/partials Initial commit 1 year ago
.gitignore Updated .gitignore 1 year ago
README.adoc PolisH 1 year ago
antora-playbook.yml Fix tag wildcards. 1 year ago
mvnw Updated maven wrapper to use Maven 3.6.3 3 years ago
mvnw.cmd Updated maven wrapper to use Maven 3.6.3 3 years ago
pom.xml Adds antora extension and update ui version 1 year ago

README.adoc

= Spring Cloud Commons 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 Commons 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
----