Getting started
Roq allows to easily create a static website or blog using Quarkus super-powers.
Create your first Roq site in seconds.
1. Install the Roq CLI
Install it 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
Use the web creator to configure your site and download it as a ZIP (or push directly to GitHub):
Or create from the CLI (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). Add plugins and pick a different theme with -x (e.g. -x theme:resume, -x plugin:tagging). To start from scratch, use the base theme: -x theme:base. Browse all available themes and plugins.
3. Start dev mode
$ cd my-site
$ roq start
Listening on http://localhost:8080
✓ Live-reload enabled