This repository contains the Antora playbook for the <i>Epic Remastered</i> project.
Antora is the static site generator software that we use to build the project output that you find at https://epicremastered.com. The playbook holds contains important configuration files and tells Antora where to find the components of the project.
The components include:
-
Home: The home page for HTML outputs, frontmatter for PDF outputs, and other content that does not belong in one of the more specific components.
-
Core: The main body of the project, principally the core rules of play.
-
Battles: Rules for setup and play, including scenarios and campaigns.
-
Armies: Guidance on how to choose and build your armies, along with army lists that detail detachments, unit data sheets and points costs for each faction in the game.
-
Contributor’s Guide: Guidance for contributors, to help with governance and consistency, and to document our methods in a transparent way.
This playbook contains additional project elements, such as:
-
The user interface (UI) template.
-
The overrides that we use to customise the UI template to suit the needs of the project (the supplemental UI).
-
Configuration for the extensions we need to provide features such as the text search tool and automated PDF outputs.
|
Note
|
These instructions assume that you have adequate knowledge of the Git version control system and related dependencies. (We hope to provide more beginner-friendly instructions in future.) |
The components of the project reside in various Git repositories. You’ll find the repositories for these components at the locations listed in antora-playbook.yml.
To use this playbook and to compile the project on your local machine you’ll need to install Antora.
Antora is the static site generator that we use to generate the <i>Epic Remastered</i> project website. Future updates to Antora may provide a direct way for us to generate other outputs too, such as PDF — but in the meantime we’ll have to resort to more time-consuming methods for such formats.
This playbook contains the instructions that we want Antora to use to generate the <i>Epic Remastered</i> outputs.
-
We use the main github-playbook.yml file in the automated 'continuous deployment' pipeline, to publish the website and other outputs.
-
You can use the local-playbook.yml file for your 'local' development, so that you can preview the outputs on your computer with the changes you make, and check the build process for errors.
Once you’ve installed Antora and saved this playbook to a local directory, you’re ready to run Antora.
Copyright 2020–2026 Eric Weston and the Epic Remastered project contributors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This publication is completely unofficial and in no way endorsed by Games Workshop Ltd.
Adeptus Astartes, Battlefleet Gothic, Blood Angels, Cadian, Catachan, the Chaos device, the Chaos logo, Citadel, the Citadel device, Codex, Daemonhunters, Dark Angels, Dark Eldar, the Double-Headed/Imperial Eagle device (Aquila), 'Eavy Metal, Eldar, Eldar symbol devices, Epic, Eye of Terror, Fanatic, the Fanatic logo, the Fanatic II logo, Fire Warrior, Forge World, Games Workshop, Games Workshop logo, Genestealer, Golden Demon, Great Unclean One, Keeper of Secrets, Khemri, Khorne, Kroot, Lord of Change, Necron, Nurgle, Ork, Ork skull devices, Sisters of Battle, Slaanesh, Space Marine, Space Marine chapters, Space Marine chapter logos, Tau, the Tau caste designations, Tyranid, Tzeentch, Ultramarines, Warhammer, Warhammer 40k device, Warhammer World logo, White Dwarf, the White Dwarf logo, and all associated marks, names, races, race insignia, characters, vehicles, locations, units, illustrations and images from the Warhammer 40,000 universe are either ®, ™ and/or © Copyright Games Workshop Ltd, variably registered in the UK and other countries around the world. Used without permission. No challenge to their status intended. All Rights Reserved to their respective owners.