Getting started with Quarkus Roq
Roq allows to easily create a static website or blog using Quarkus super-powers.
In this video, we initialise the repository and set up GitHub Pages, discover a few basics and create a new blog post.
Get up and running with Roq
-
👉 Install the Quarkus CLI.
-
🚀 Generate the starter app using the CLI (you can change the name), or via code.quarkus.io
quarkus create app roq-with-blog -x=io.quarkiverse.roq:quarkus-roq
-
🎮 start dev-mode:
cd roq-with-blog quarkus dev
-
💻 Your site is available on localhost for dev
-
🍾 Time to Roq the basics!
-
☀️ If you found some happiness with Roq, please support us:
Star
How it works

Advantages of Roq
Knowing that you don’t need to learn Quarkus or Java to use Roq, consider the following advantages:
-
Quarkus-based: Since Roq is just a very thin layer on top of Quarkus, it ensures that the tool stays up to date and benefits from the robust support provided by the Quarkus ecosystem.
-
For everyone: It is very easy to use with any level of knowledge. You can start with an existing theme (as a dependency) and only write Markdown or Asciidoc content, or customize everything.
-
Reproducibility Across Platforms: Unlike some other SSG, Roq offers better reproducibility across multiple platforms, ensuring more consistent and predictable results when building or deploying.
-
Easy to maintain: Managing dependencies and updates is easier with Roq thanks to Maven and Gradle. Other systems such as Go or Ruby can be difficult to maintain and make reproducible across environments.
-
Speed: Roq is using Quarkus for dev and build. Quarkus is famous for being supersonic and subatomic, with one example showing a Roq site build in just 20 milliseconds, greatly reducing build times compared to traditional generators.
-
Type Safety (via Qute templates): Roq leverages Quarkus Qute’s type safety in templates and posts, making it easier to handle links, data injection, and other dynamic content with confidence.
-
Local Development Experience: Roq provides a smoother local development experience without the need to "test in production," as is often necessary with other SSGs due to its difficulties in running locally.
-
Code Completion (coming soon): Thanks to Qute, Roq offers code completion, which is beneficial when working in templates, helping to reduce errors and improve developer productivity.
The blog
You may find a few interesting things in there, here are 3 random articles from our blog.
Roq with Blogs
🚀 Roq 1.0 is ON! It is time to give it a shot and give us feedback 🚀
2024, Oct 31 — 2 minute(s) readRoq n Roll Your Tests 🎶
Testing the actual Roq generation has never been this cool! 🎸
2025, Jan 28 — 1 minute(s) read