Getting started
Roq allows to easily create a static website or blog using Quarkus super-powers.
Install the Roq CLI with JBang and create your first site in seconds.
Get up and running with Roq
1. Install the Roq CLI via JBang (installs JBang if needed):
$ curl -Ls https://sh.jbang.dev | bash -s - trust add https://repo1.maven.org/maven2/io/quarkiverse/roq/
$ curl -Ls https://sh.jbang.dev | bash -s - app install --fresh --force roq@quarkiverse/quarkus-roq
✓ roq installed
> iex "& { $(iwr https://ps.jbang.dev) } trust add https://repo1.maven.org/maven2/io/quarkiverse/roq/"
> iex "& { $(iwr https://ps.jbang.dev) } app install --fresh --force roq@quarkiverse/quarkus-roq"
✓ roq installed
2. Create your site (you can change the name):
$ roq create my-site
Creating Roq site: my-site
✓ Roq site created in ./my-site
This creates a site with the default theme (blog layout, dark mode, sidebar, SEO). To start from scratch with a minimal HTML structure and full control over the design, use the base theme instead: roq create my-site -x theme:base. Browse all available themes.
3. Start dev mode:
$ cd my-site
$ roq start
Listening on http://localhost:8080
✓ Live-reload enabled