Quarkus Roq FrontMatter

Quarkus Roq FrontMatter is a Quarkus extension that create a website from your Markdown/Asciidoc/Html pages using FrontMatter headers (url, layout, seo, data).

The documentation is available in the Roq website.

Roq FrontMatter is already included as part of the Roq Static Site Generator extension io.quarkiverse.roq:quarkus-roq, Follow Standalone installation section to use it standalone.

Standalone installation

It is included as part of the Roq Static Site Generator extension io.quarkiverse.roq:quarkus-roq. You can also use it standalone.

If you want to use this extension standalone, you need to add the io.quarkiverse.roq:quarkus-roq-frontmatter extension first to your build file.

For instance, with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.roq</groupId>
    <artifactId>quarkus-roq-frontmatter</artifactId>
    <version>1.0.8</version>
</dependency>

Extension Configuration Reference

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.roq.site.root-path

The root path of your site (e.g. /blog) relative the quarkus http root path. This is to be used only when the site is living next to a Quarkus application. Use quarkus.http.root-path for GitHub Pages relative url.

Environment variable: QUARKUS_ROQ_SITE_ROOT_PATH

string

/

quarkus.roq.site.url

the base hostname & protocol for your site, e.g. http://example.com

Environment variable: QUARKUS_ROQ_SITE_URL

string

quarkus.roq.site.route-order

The order of the route which handles the templates. <p> By default, the route is executed before the default routes (static resources, etc.).

Environment variable: QUARKUS_ROQ_SITE_ROUTE_ORDER

int

1100

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

roq.site.ignored-files

The ignored files in the Roq site directory (you can use glob expressions).

Environment variable: ROQ_SITE_IGNORED_FILES

list of string

/,,.,${quarkus.roq.data.dir}/**

roq.site.template-files

The files to use as raw templates (n the Roq site directory (you can use glob expressions)),

Environment variable: ROQ_SITE_TEMPLATE_FILES

list of string

partials/,includes/,tags/**

roq.site.static-files

Files to serve as static in the Roq site directory (you can use glob expressions)

Environment variable: ROQ_SITE_STATIC_FILES

list of string

static/**

roq.site.layouts-dir

The directory containing layouts in the Roq site directory (dir name).

Environment variable: ROQ_SITE_LAYOUTS_DIR

string

layouts

roq.site.generator

When enabled it will select all FrontMatter pages in Roq Generator

Environment variable: ROQ_SITE_GENERATOR

boolean

true

roq.site.future

Show future pages

Environment variable: ROQ_SITE_FUTURE

boolean

false

roq.site.images-path

The public path containing pages and posts images (relative to the site path)

Environment variable: ROQ_SITE_IMAGES_PATH

string

static/assets/images

roq.site.theme

This will be used to replace :theme when resolving layouts (e.g. layout: :theme/main.html)

Environment variable: ROQ_SITE_THEME

string

roq.site.draft

Show draft pages

Environment variable: ROQ_SITE_DRAFT

boolean

false

roq.site.date-format

Format for dates

Environment variable: ROQ_SITE_DATE_FORMAT

string

yyyy-MM-dd[ HH:mm][:ss][ Z]

roq.site.time-zone

The default timezone

Environment variable: ROQ_SITE_TIME_ZONE

string

document timezone if provided or system timezone

roq.site.collections."collections-map"

If this collection is enabled

Environment variable: ROQ_SITE_COLLECTIONS__COLLECTIONS_MAP_

boolean

true

roq.site.collections."collections-map".hidden

If true, the collection won’t be available on path but consumable as data.

Environment variable: ROQ_SITE_COLLECTIONS__COLLECTIONS_MAP__HIDDEN

boolean

false