Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugin asciidoc jruby #329

Merged
merged 3 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,12 @@

The Roq Static Site Generator extension allows to easily create a static website or blog (such as [Roq's blog](https://pages.quarkiverse.io/quarkus-roq/)) using Quarkus super-powers.

## Get up and running with Roq
Get started [here](https://pages.quarkiverse.io/quarkus-roq/docs/)!

[Click here](https://code.quarkus.io/?a=roq-my-site&e=io.quarkiverse.roq%3Aquarkus-roq) to generate your Roq Starter App.

or use the [Quarkus CLI](https://quarkus.io/guides/cli-tooling):

```shell
quarkus create app roq-my-site -x=io.quarkiverse.roq:quarkus-roq
```

Then
```shell
cd roq-with-blog
quarkus dev
```

Learn more in the [documentation](https://docs.quarkiverse.io/quarkus-roq/dev/index.html).
For those looking for the Roq Quarkus extensions (which can also be used standalone):
- [Roq Data](https://docs.quarkiverse.io/quarkus-roq/dev/quarkus-roq-data.html): Use json/yaml files content from your templates and articles with type safety.
- [Roq FrontMatter](https://docs.quarkiverse.io/quarkus-roq/dev/quarkus-roq-frontmatter.html): Create a website from your Markdown/Asciidoc/Html pages using FrontMatter headers (url, layout, seo, data).
- [Roq Generator](https://docs.quarkiverse.io/quarkus-roq/dev/quarkus-roq-generator.html): Command to run any Quarkus web application and extract it in a directory as purely static files (html and assets).

## Contributors ✨

Expand Down
4 changes: 3 additions & 1 deletion blog/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
data/*.json
data/*.json
data/project-info.yml
templates/partials/doc/configs/**
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
%gh-pages.quarkus.http.root-path=/quarkus-roq/
quarkus.web-bundler.dependencies.auto-import=all
quarkus.log.category."io.quarkiverse.roq.frontmatter.deployment.scan".level=DEBUG
quarkus.default-locale=en
quarkus.default-locale=en
quarkus.asciidoctorj.attributes.icons=font
quarkus.asciidoctorj.attributes.source-highlighter=highlight.js
12 changes: 6 additions & 6 deletions blog/content/about.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: About
description: |
Roq stands out in the Java development community as a powerful static site generator, bridging the gap between the
likes of Gatsby, Hugo, and the broader backend community. With GitHub Actions support out-of-the-box, Roq is easy to use for beginners, but also flexible enough to provide
Java hooks for advanced users.
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 stands out in the Java development community as a powerful static site generator, bridging the gap between the likes of Gatsby, Hugo, and the broader backend community. As Andy Damevin explains, while tools like Jekyll once filled this space, they’ve become outdated and cumbersome, especially with Ruby’s limitations. Roq offers a modern solution, leveraging Quarkus with no configuration needed, allowing developers to start quickly using Codestart and simply editing their site directory.

With GitHub Actions support out-of-the-box, Roq is easy to use for beginners, but also flexible enough to provide Java hooks for advanced users.
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.

**This tool is a testament to how extensible and powerful Quarkus is, offering a low-risk yet highly capable platform that will evolve as demand grows.**

## Origins

I wrote a [blog post]({site.url('posts/roq-with-blogs')}) explaining how it all started.

## Credits

`Those are generated as a JSON by all-contributors, then we leverage roq-data to print them... slick 🏄!`
Expand Down
Loading
Loading