This repository contains the source of the Vert.x website (https://vertx.io).
To build the project, before running npm install, be sure to have installed libsass. On Fedora:
sudo dnf install libsass libsass-devel
Initialize local copy:
npm i
Download and extract AsciiDoc source files of the Vert.x documentation:
npm run update-docs
Start the website in development mode:
npm run dev
Export a static website:
npm run build
The website will be exported the out directory.
Test the exported website:
cd out
npx serve
If you don't want to install Node.js, use Docker instead:
# Initialize local copy
rm -rf node_modules
docker run -it -v $(pwd):/vertx node:12-slim sh -c "cd /vertx && npm i"
# Download and extract docs
docker run -it -v $(pwd):/vertx openjdk:11-jdk-slim sh -c "cd /vertx/docs && ./gradlew"
# Start website in development mode
docker run -it -v $(pwd):/vertx -p 3000:3000 node:12-slim \
sh -c "cd /vertx && npm run dev"
Alternatively, build a Docker image that runs the static website inside NGINX (no hot reloading!):
docker build -t vertx-web-site .
docker run -it -p 80:80 vertx-web-site
The community page contains a list of people who have contributed to any of the Vert.x repositories. Generating this list takes some time and requires you to authenticate against the GitHub API. Due to this, it is disabled by default.
If you want to generate the list of contributors, first create a
personal access token. Then, set the
environment variable GITHUB_ACCESS_TOKEN to this token. For example,
GITHUB_ACCESS_TOKEN=abcdefghijklmnopqrs0123456789 npm run build
The website is currently automatically deployed to https://vertx-web-site.github.io/. For this, we set up a separate GitHub repository with GitHub Pages.
We also created a GitHub Actions Workflow. This workflow runs each time a new commit is pushed. It builds the website and completely replaces the contents of the GitHub Pages repository, which in turn triggers a new deployment of the website.