This guide describes the asciidoc format and conventions that Quarkus has adopted.
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:
Property Name | Value | Description |
---|---|---|
|
|
The current version of the project. |
|
The location of the project home page. |
|
|
The location of the getting started page. |
|
|
The location of the live coding page. |
|
|
The location of the extension authors guide page. |
|
|
The location of the project github organization. |
|
|
Quarkus GitHub URL common base prefix. |
|
|
Quarkus URL for git clone referenced by the documentation. |
|
|
Quarkus URL to master source archive. |
|
|
Quarkus URL to master blob source tree; used for referencing source files. |
|
|
Quarkus URL to master source tree root; used for referencing directories. |
|
|
Quarkus URL to the issues page. |
|
|
Quarkus URL to set of container images delivered for Quarkus. |
|
|
URL of our chat. |
|
|
Email used to subscribe to our mailing list. |
|
|
Mailing list index page. |
|
|
Quickstarts URL common base prefix. |
|
|
Quickstarts URL for git clone referenced by the documentation. |
|
|
|
Quickstarts URL to master source archive. |
|
|
Quickstarts URL to master blob source tree; used for referencing source files. |
|
|
Quickstarts URL to master source tree root; used for referencing directories. |
|
|
Recommended Graal VM version to use. |