-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5d2c980
Showing
24 changed files
with
1,283 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
* | ||
!target/*-runner | ||
!target/*-runner.jar | ||
!target/lib/* | ||
!target/quarkus-app/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Roq Site Deploy | ||
|
||
on: | ||
push: | ||
branches: [ main ] # Switch to the branch which should be deployed to GitHub Pages | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Generate Roq Site | ||
uses: quarkiverse/quarkus-roq@v1 | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} # Used to automatically get the GitHub Pages url | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
#Maven | ||
target/ | ||
pom.xml.tag | ||
pom.xml.releaseBackup | ||
pom.xml.versionsBackup | ||
release.properties | ||
.flattened-pom.xml | ||
|
||
# Eclipse | ||
.project | ||
.classpath | ||
.settings/ | ||
bin/ | ||
|
||
# IntelliJ | ||
.idea | ||
*.ipr | ||
*.iml | ||
*.iws | ||
|
||
# NetBeans | ||
nb-configuration.xml | ||
|
||
# Visual Studio Code | ||
.vscode | ||
.factorypath | ||
|
||
# OSX | ||
.DS_Store | ||
|
||
# Vim | ||
*.swp | ||
*.swo | ||
|
||
# patch | ||
*.orig | ||
*.rej | ||
|
||
# Local environment | ||
.env | ||
|
||
# Plugin directory | ||
/.quarkus/cli/plugins/ | ||
# TLS Certificates | ||
.certs/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
maven-wrapper.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import java.io.IOException; | ||
import java.io.InputStream; | ||
import java.net.Authenticator; | ||
import java.net.PasswordAuthentication; | ||
import java.net.URI; | ||
import java.net.URL; | ||
import java.nio.file.Files; | ||
import java.nio.file.Path; | ||
import java.nio.file.Paths; | ||
import java.nio.file.StandardCopyOption; | ||
import java.util.concurrent.ThreadLocalRandom; | ||
|
||
public final class MavenWrapperDownloader { | ||
private static final String WRAPPER_VERSION = "3.3.2"; | ||
|
||
private static final boolean VERBOSE = Boolean.parseBoolean(System.getenv("MVNW_VERBOSE")); | ||
|
||
public static void main(String[] args) { | ||
log("Apache Maven Wrapper Downloader " + WRAPPER_VERSION); | ||
|
||
if (args.length != 2) { | ||
System.err.println(" - ERROR wrapperUrl or wrapperJarPath parameter missing"); | ||
System.exit(1); | ||
} | ||
|
||
try { | ||
log(" - Downloader started"); | ||
final URL wrapperUrl = URI.create(args[0]).toURL(); | ||
final String jarPath = args[1].replace("..", ""); // Sanitize path | ||
final Path wrapperJarPath = Paths.get(jarPath).toAbsolutePath().normalize(); | ||
downloadFileFromURL(wrapperUrl, wrapperJarPath); | ||
log("Done"); | ||
} catch (IOException e) { | ||
System.err.println("- Error downloading: " + e.getMessage()); | ||
if (VERBOSE) { | ||
e.printStackTrace(); | ||
} | ||
System.exit(1); | ||
} | ||
} | ||
|
||
private static void downloadFileFromURL(URL wrapperUrl, Path wrapperJarPath) | ||
throws IOException { | ||
log(" - Downloading to: " + wrapperJarPath); | ||
if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { | ||
final String username = System.getenv("MVNW_USERNAME"); | ||
final char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); | ||
Authenticator.setDefault(new Authenticator() { | ||
@Override | ||
protected PasswordAuthentication getPasswordAuthentication() { | ||
return new PasswordAuthentication(username, password); | ||
} | ||
}); | ||
} | ||
Path temp = wrapperJarPath | ||
.getParent() | ||
.resolve(wrapperJarPath.getFileName() + "." | ||
+ Long.toUnsignedString(ThreadLocalRandom.current().nextLong()) + ".tmp"); | ||
try (InputStream inStream = wrapperUrl.openStream()) { | ||
Files.copy(inStream, temp, StandardCopyOption.REPLACE_EXISTING); | ||
Files.move(temp, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING); | ||
} finally { | ||
Files.deleteIfExists(temp); | ||
} | ||
log(" - Downloader complete"); | ||
} | ||
|
||
private static void log(String msg) { | ||
if (VERBOSE) { | ||
System.out.println(msg); | ||
} | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
wrapperVersion=3.3.2 | ||
distributionType=source | ||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.8/apache-maven-3.9.8-bin.zip | ||
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Jug-Vale.github.io | ||
|
||
This project uses Quarkus, the Supersonic Subatomic Java Framework. | ||
|
||
If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>. | ||
|
||
## Running the application in dev mode | ||
|
||
You can run your application in dev mode that enables live coding using: | ||
|
||
```shell script | ||
./mvnw compile quarkus:dev | ||
``` | ||
|
||
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>. | ||
## Packaging and running the application | ||
|
||
The application can be packaged using: | ||
|
||
```shell script | ||
./mvnw package | ||
``` | ||
|
||
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. | ||
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. | ||
|
||
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. | ||
|
||
If you want to build an _über-jar_, execute the following command: | ||
|
||
```shell script | ||
./mvnw package -Dquarkus.package.jar.type=uber-jar | ||
``` | ||
|
||
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. | ||
|
||
## Creating a native executable | ||
|
||
You can create a native executable using: | ||
|
||
```shell script | ||
./mvnw package -Dnative | ||
``` | ||
|
||
Or, if you don't have GraalVM installed, you can run the native executable build in a container using: | ||
|
||
```shell script | ||
./mvnw package -Dnative -Dquarkus.native.container-build=true | ||
``` | ||
|
||
You can then execute your native executable with: `./target/Jug-Vale.github.io-1.0.0-SNAPSHOT-runner` | ||
|
||
If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>. | ||
|
||
## Related Guides | ||
|
||
- Roq ([guide](https://docs.quarkiverse.io/quarkus-roq/dev/)): Static Site Generator with Quarkus super-powers. | ||
|
||
## Provided Code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
layout: :theme/404 | ||
image: iamroq.png | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: About | ||
description: | | ||
Roq is a powerful static site generator that combines the best features of tools like Jekyll and Hugo, but within the Java ecosystem. It offers a modern approach with Quarkus at its core, requiring zero configuration to get started —ideal for developers who want to jump right in, while still being flexible enough for advanced users to hook into Java for deeper customization. | ||
layout: :theme/page | ||
--- | ||
|
||
# About Roq | ||
|
||
Roq is a powerful static site generator that combines the best features of tools like Jekyll and Hugo, but within the Java ecosystem. It offers a modern approach with Quarkus at its core, requiring zero configuration to get started —ideal for developers who want to jump right in, while still being flexible enough for advanced users to hook into Java for deeper customization. | ||
|
||
## Authors | ||
|
||
<div class="authors"> | ||
<!-- authors.yml is in the data/ --> | ||
{#for id in cdi:authors.fields} | ||
{#let author=cdi:authors.get(id)} | ||
<!-- the author-card tag is defined in the default Roq theme --> | ||
{#author-card name=author.name avatar=author.avatar nickname=author.nickname profile=author.profile /} | ||
{/for} | ||
</div> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: Hello, world! I'm Roq | ||
description: I provide you with all the tools to generate static websites with Quarkus super-powers. | ||
name: I am ROQ | ||
simple-name: ROQ | ||
image: iamroq.png | ||
social-twitter: quarkusio | ||
social-facebook: | ||
social-github: quarkiverse/quarkus-roq | ||
social-linkedin: quarkusio | ||
layout: :theme/index | ||
--- | ||
|
||
<h1>Ready to Roq my world!</h1> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
layout: :theme/post | ||
title: "The First Roq!" | ||
description: This is my first article ever made with Quarkus Roq | ||
image: blog.avif | ||
tags: blogging | ||
author: roqqy | ||
cool: this is cool :) | ||
fun: and fun! | ||
--- | ||
|
||
You can access page data like this: | ||
```markdown | ||
* \{page.data.cool} | ||
* \{page.data.fun} | ||
``` | ||
**will render ⤵** | ||
|
||
* {page.data.cool} | ||
* {page.data.fun} | ||
|
||
|
||
There are a few helpers on the `page` variable ([more on variables](https://docs.quarkiverse.io/quarkus-roq/dev/index.html#variables)): | ||
|
||
```markdown | ||
> \{page.date.format('YYYY')}: \{page.description} | ||
``` | ||
**will render ⤵** | ||
|
||
> {page.date.format('YYYY')}: {page.description} | ||
--- | ||
|
||
It's time to write awesome articles! | ||
|
||
__Thank you!__ | ||
|
||
**PS:** To make the tag work ([#blogging]({site.url.resolve('posts/tag/blogging')})), you need to [enable tagging](https://pages.quarkiverse.io/quarkus-roq/docs/plugins#plugin-tagging). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
roqqy: | ||
name: "Roqqy Balboa" | ||
job: Roq Boxer | ||
nickname: roqqy | ||
profile: "https://github.com/quarkiverse/quarkus-roq" | ||
avatar: "https://raw.githubusercontent.com/quarkiverse/quarkus-roq/refs/heads/main/blog/static/assets/images/iamroq.png" | ||
bio: | | ||
Quarkus is my go-to framework for making Java development not only faster but more fun. | ||
I’m driven by the mission to create high-performance, lightweight microservices that scale effortlessly in the cloud. | ||
With Quarkus, I can push Java to its limits, and nothing excites me more than exploring new ways to optimize and streamline applications with this amazing toolkit. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
items: | ||
- title: "Blog" | ||
path: "/" | ||
icon: "fa-regular fa-newspaper" | ||
- title: "Documentation" | ||
path: "https://pages.quarkiverse.io/quarkus-roq/docs/" | ||
icon: "fa-solid fa-book" | ||
target: "_blank" | ||
- title: "About" | ||
path: "/about" | ||
icon: "fa fa-thumbs-up" |
Oops, something went wrong.