A Jekyll template for creating books in multiple formats
CSS JavaScript Shell HTML Batchfile Ruby
Clone or download
arthurattwell Merge pull request #287 from electricbookworks/docs-book-setup-page
Move setup guidance to a more sensible, dedicated page
Latest commit 36e0366 Jul 17, 2018
Permalink
Failed to load latest commit information.
_app Fixes and improvements for making translated apps possible Jul 8, 2018
_configs Add relevant excludes to live output Jun 5, 2018
_data Add French sample description Jul 16, 2018
_docs Move setup guidance to a more sensible, dedicated page Jul 17, 2018
_epub Move local mathjax from epub to assets/js for app Oct 21, 2017
_includes Fall back to book and project description when page description not a… Jul 16, 2018
_layouts Add pagination by default to web and app outputs Jan 30, 2018
_output Remove epub from template _output Jun 29, 2017
_sass Make visuallyhidden available for general-purpose use Jul 8, 2018
_tools Add grey profiles and documentation Mar 27, 2018
assets Update search index Jul 1, 2018
book Make visuallyhidden available for general-purpose use Jul 8, 2018
samples Make visuallyhidden available for general-purpose use Jul 8, 2018
.gitignore Ignore folders cordova will build Dec 10, 2017
CHANGELOG.md Update changelog Jul 17, 2018
CNAME Create CNAME Sep 3, 2017
Gemfile Use Jekyll 3.8.3 Jul 1, 2018
Gemfile.lock Use Jekyll 3.8.3 Jul 1, 2018
LICENSE Create LICENSE Mar 28, 2017
README.md Add guidance for setting up a computer with the EB dependencies Jul 16, 2018
_config.yml Bump to version 0.12.0 Jul 1, 2018
_prose.yml Hide .htaccess on prose.io Apr 27, 2018
eslint.json Add gulpfile and package Oct 8, 2017
gulpfile.js Add detailed error reporting on gulp output Apr 17, 2018
index.md Fix offline links and update home page Jul 1, 2018
package-lock.json Check for colour profiles before processing images Mar 22, 2018
package.json Check for colour profiles before processing images Mar 22, 2018
run-linux.sh Fix typos, one critical Jun 30, 2018
run-mac.command Fix typos, one critical Jun 30, 2018
run-windows.bat Fix typos, one critical Jun 30, 2018
search.md Work in progress for localising search May 14, 2018

README.md

The Electric Book Jekyll template

A Jekyll template for creating books in multiple formats:

  • print PDFs for high-end book publishing
  • screen PDFs for reading on screen
  • a website of books
  • epubs for ebook distribution
  • ebook apps for Android and iOS
  • MS Word outputs for old-school editing.

Usage and documentation

  1. Copy or clone this folder
  2. Edit as needed:
    • _data/meta.yml
    • the stylesheet variables in book/styles
    • the content files in book/text
  3. Run the run- script for your operating system.

Read the guide for much more. The guide is also an example of the template in action.

Dependencies

To use the Electric Book template on your machine, you need to have installed:

And of course a good editor like Sublime, Brackets or Atom.