Antora UI for Camptocamp

This repository is based and forked from the Antora default UI.

The reason for this fork is so we could apply the following modifications:

• customize the UI with the DevOps Stack logo, favicon and hyperlink to its website and repository, as well as to Camptocamp’s website;

• add support for Terraform syntax highlighting by adding this extension of highlight.js (see here the supported languages);

• provide more readable colors for the syntax highlighting by adding a custom CSS file with the same colors used by Stack Overflow (although the packaged prebuilt version of highlight.js is not directly usable by this UI project, however we can get the Stack Overflow CSS style from the multiple CSS styles contained there);

Usage

In order to use this UI, we simply create a *.zip bundle with a GitHub Actions workflow that is then pointed to by our antora-playbook.yaml available here.

If it the first time you touch on this project, clone it using the following procedure. This will allow you to maintain this repository up-to-date with the upstream project.

git clone [email protected]:camptocamp/devops-stack-antora-ui.git && cd "devops-stack-antora-ui"
git remote -v
git remote add upstream https://gitlab.com/antora/antora-ui-default
git remote -v

Create a local branch synced with the original repository (you only need to do this once).

git fetch upstream
git checkout -b upstream_master upstream/master
git pull

Create you local branch synchronized with upstream.

git checkout -b my-branch main
git merge upstream_master

Important

When merging, you may have some conflicts. You will need to resolve them manually, *but take caution not to erase some of our customizations, otherwise you probably can safely accept the incoming changes.

After all this, you can open a Pull Request from you branch.

README.adoc from the forked project

The original README.adoc is available here. It contains the Code of Conduct of the project along with some other useful information.