Working with Antora
Antora is being proposed as the new docs engine for building docs.fedoraproject.org. This document rounds up some "getting started"/"working with" advice. This is not a guide for Antora. You should read the upstream documentation.
Getting Antora
Right now we are doing our work with the upstream published docker container. Ultimately we will do something different.
-
docker pull antora/antora
How to build the test site
-
Clone the Antora play book
-
git clone ssh://git@pagure.io/forks/bex/fedora-docs/docs-fp-o.git -
cd docs-fp-o -
git checkout antora-playbook -
Build the site
-
docker run -it -v $(pwd):/antora:z antora/antora site.yml+ [NOTE]
You will get a ton of warnings from the draft Packaging Guidelines Docs. You can edit the site.yml if you’d like to skip that doc set. This is remaining included to test errors. (True as of 25 April 2018)
-
View the site
-
firefox public/index.html
Where are the sources that the test site is built from?
Doc Content
Read the site.yml file. The specific branches of the specific forks of the docs are listed there.
UI
The test site currently uses the default UI provided by Antora, located at https://gitlab.com/antora/antora-ui-default/ .
The default UI is supplemented with additional code located in the supplemental-ui directory.
This replaces/adds files in the default UI.
Long term, we probably want to write a full, single UI in a separate repo, however this is undecided.