Quarkus.io Website Based on Jekyll
These instructions will get you a copy of the Quarkus.io website up and running on your local machine for development and testing purposes.
Install a full Ruby development environment
gem install bundler
Fork the project repository, then clone your fork.
git clone email@example.com:YOUR_USER_NAME/quarkusio.github.io.git
Change into the project directory:
Use bundler to fetch all required gems in their respective versions
Build the site and make it available on a local server
bundle exec jekyll serve
Now browse to http://localhost:4000
For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.
Deploying to Github Pages
The website deployment is automatically performed by GitHub Actions (when commits are pushed to the
If for some reason you need to deploy from your local machine, follow these instructions:
- Install the act executable to run GitHub Actions locally
act -s GITHUB_TOKEN=<GITHUB_TOKEN>, where <GITHUB_TOKEN> needs to be replaced with a token that allows you to push to the https://github.com/quarkusio/quarkusio.github.io repository.
Writing a blog
To write a blog:
- create an author entry in _data/authors.yaml
emailhashis used to fetch your picture form the Gravatar service
- create an blog entry under _posts
-the file name is
tagsshould be used with some care as an archive page is created for of them. Below are some basic rules to try follow:
quarkus-releaseused for Quarkus release blogs
announcementused for general announcement with some impact.
extensionused for blogs related to a specific extension.
user-storyused for stories from users/companies adopting Quarkus.
development-tipsused for blogs with tips to develop using Quarkus or Quarkus itself.
- add a tech specific, like
kafka, if your post has a significant mention/relevance to that technology.
- tags is space separated list
- tags must be in lowercase
- it's in asciidoc format, there is an example as shown with 2019-06-05-quarkus-and-web-ui-development-mode.adoc
- Be aware that the
dateattribute in the asciidoc preamble defines when the article will be published. Use a present date while writing your article to test locally, then switch to the actual target date before submitting.
- Be aware that the
- send a pull request against the develop branch and voilà
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Important: the guides are maintained in the main Quarkus repository and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc.
This website is licensed under the Creative Commons Attribution 3.0.