This guide describes the asciidoc format and conventions that Quarkus has adopted.

References

The following links provide background on the general conventions and Asciidoc syntax.

Variables for Use in Documents

The following variables externalize key information that can change over time, and so references to such information should be done by using the variable inside of {} curly brackets. The complete list of externalized variables for use is given in the following table:

Table 1. Variables
Property Name Value Description

{quarkus-version}

2.10.2.Final

The current version of the project.

{quarkus-home-url}

https://quarkus.io

The location of the project home page.

{quarkus-site-getting-started}

https://quarkus.io/getting-started

The location of the getting started page.

{quarkus-org-url}

https://github.com/quarkusio

The location of the project GitHub organization.

{quarkus-base-url}

https://github.com/quarkusio/quarkus

Quarkus GitHub URL common base prefix.

{quarkus-clone-url}

https://github.com/quarkusio/quarkus.git

Quarkus URL for git clone referenced by the documentation.

{quarkus-archive-url}

https://github.com/quarkusio/quarkus/archive/main.zip

Quarkus URL to main source archive.

{quarkus-blob-url}

https://github.com/quarkusio/quarkus/blob/main

Quarkus URL to main blob source tree; used for referencing source files.

{quarkus-tree-url}

https://github.com/quarkusio/quarkus/tree/main

Quarkus URL to main source tree root; used for referencing directories.

{quarkus-issues-url}

https://github.com/quarkusio/quarkus/issues

Quarkus URL to the issues page.

{quarkus-images-url}

https://github.com/quarkusio/quarkus-images/tree

Quarkus URL to set of container images delivered for Quarkus.

{quarkus-chat-url}

https://quarkusio.zulipchat.com/#

URL of our chat.

{quarkus-mailing-list-subscription-email}

quarkus-dev+subscribe@googlegroups.com

Email used to subscribe to our mailing list.

{quarkus-mailing-list-index}

https://groups.google.com/d/forum/quarkus-dev

Mailing list index page.

{quickstarts-base-url}

https://github.com/quarkusio/quarkus-quickstarts

Quickstarts URL common base prefix.

{quickstarts-clone-url}

https://github.com/quarkusio/quarkus-quickstarts.git

Quickstarts URL for git clone referenced by the documentation.

{quickstarts-archive-url}

https://github.com/quarkusio/quarkus-quickstarts/archive/main.zip

Quickstarts URL to main source archive.

{quickstarts-blob-url}

https://github.com/quarkusio/quarkus-quickstarts/blob/main

Quickstarts URL to main blob source tree; used for referencing source files.

{quickstarts-tree-url}

https://github.com/quarkusio/quarkus-quickstarts/tree/main

Quickstarts URL to main source tree root; used for referencing directories.

{graalvm-version}

22.1.0

Recommended GraalVM version to use.

{graalvm-flavor}

22.1.0-java11

The full flavor of GraalVM to use e.g. 19.3.1-java11. Make sure to use a java11 version.