Vert.x Website

This repository contains the source of the Vert.x website (https://vertx.io).

Quickstart

Initialize local copy:

npm i
npx playwright install --with-deps chromium

Download, extract and compile 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

Docker

If you don't want to install Node.js, use Docker instead:

# Initialize local copy
rm -rf node_modules docs/node_modules
docker run -it -v $(pwd):/vertx node:20-slim sh -c "cd /vertx && npm i"

# Download, extract, and compile docs
docker run -it -v $(pwd):/vertx node:20-slim sh -c "cd /vertx && npm run update-docs"

# Start website in development mode
docker run -it -v $(pwd):/vertx -p 3000:3000 node:20-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

Note: if you're on a Mac with Apple Silicon and configured Docker to use arm64, you might have to add the --platform parameter during build:

docker build -t vertx-web-site . --platform=linux/amd64

Automatic generation of the list of contributors

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

Automated deployment

The Deploy Workflow runs every time a new commit is pushed. It publishes the website to https://vertx.io/.