README.md

Fedora Docs built with Antora

This repository contains the main Antora playbook that defines the whole site. Please see the site.yml for a list of repositories used to build the site.

Build and preview

The antora-build script included in this repository is used to build the site. The build happens in a container — so no dependencies except the Docker runtime need to be installed.

To build the site, run:

$ ./antora-build site.yml

The result will be in a ./public/ directory.

To preview the site, either open the ./public/en_US/index.html file in a web browser, or run a local web server in a container:

$ sudo docker run --rm -v $(pwd)/public:/usr/share/nginx/html:ro -p 8080:80 nginx

The site will be available at http://localhost:8080/en_US/.