Technical overview

To set up the workflow, you need some technical confidence. Once it’s set up, non-technical editorial team members with a couple of hours training (taught or self-taught) can add and edit books in it.

The technical team members who run the workflow should be familiar with:

How it works

The template is set up as a Jekyll project, with lots of predefined defaults. When you run npm run electric-book commands, Jekyll builds those snippets and your content into HTML pages.

See ‘Structure’ below for detail on the template’s structure, and Jekyll’s docs on structure. In short:

Structure

A project folder (which you should track as a repository with Git) can contain one or more related books. Its folders and files follow the standard Jekyll structure. We store each book’s content in its own subfolder. In the template, the first book folder is simply called book.

Here is an explanation of folders and files in the template.

Files and folders to ignore

You should keep the following files and folders, but you can largely ignore them.