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}

0.23.2

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-site-live-coding}

https://quarkus.io/live-coding

The location of the live coding page.

{quarkus-site-extension-authors-guide}

https://quarkus.io/documentation/extension-authors-guide

The location of the extension authors guide 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/master.zip

Quarkus URL to master source archive.

{quarkus-blob-url}

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

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

{quarkus-tree-url}

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

Quarkus URL to master 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/master.zip

Quickstarts URL to master source archive.

{quickstarts-blob-url}

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

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

{quickstarts-tree-url}

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

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

{graalvm-version}

19.2.0.1

Recommended Graal VM version to use.