Giter VIP home page Giter VIP logo

er-playbook's Introduction

<i>Epic Remastered</i> — Playbook

About this repository, Antora and the playbook

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 tells Antora where to find the components of the project.

The components include:

  • Core — The main body of rules content.

  • Battles — Rules for setup of the playing area, scenarios and campaigns.

  • Armies — Army lists for each faction in the game.

  • Contributor’s Guide — Guidance for project contributors.

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).

How to build a local preview of the project

Clone the repositories

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.

Install Antora

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.

Understand the playbook

This playbook contains the instructions that we want Antora to use to generate the <i>Epic Remastered</i> website.

  • We use the main github-playbook.yml file in the automated 'continuous integration' pipeline, to publish the actual website.

  • You can use the local-playbook.yml file for your 'local' development, so that you can preview the site on your computer with the changes you make.

Generate the local development preview site

Once you’ve installed Antora and saved this playbook to a local directory, you’re ready to run Antora.

Project team

Development of <i>Epic Remastered</i> is led by the project team.

Copyright 2020 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.

Disclaimer

This publication is completely unofficial and in no way endorsed by Games Workshop Ltd.

Trademark list

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.

er-playbook's People

Contributors

digi-brain avatar guyharperday avatar

Watchers

 avatar  avatar

er-playbook's Issues

Aaargh, I've broken the site during attempt to upgrade to Antora 3.1

@GuyHarperDay Hi Guy, I hope you're well. I'm sorry to bother you, but is there any chance you can bail me out??! I suspect it'll be simple intervention from your side, but I'm a bit lost.

I've tried to upgrade the Epic Remastered project to Antora 3.1, but the build failed after the actions deleted the content of the site. I've no idea how to either fix the problem or revert GitHub Pages the it's previous published state while I experiment with the problem.

Any help much appreciated!!

Eric

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.