Quick start
This quick setup assumes you already have Jekyll, Node and Prince (for PDF output) installed. If not, see setup guidance here.
Create a new project
- Download
electric-book.zip
from the latest release and extract it. - In the extracted
electric-book
folder, runnpm run electric-book
to see available commands and options. - Run
npm run electric-book -- install
first. You should only need to do this once. -
Run
npm run electric-book -- output
script to serve a website of your project.The template includes two books:
book
: a bare-bones book to start working in; andsamples
: a long book containing loads of examples.
Edit your first book
- Open
_data/works/book/default.yml
and replace the sample book information there with your project and book information. - In the
book
folder, overwrite the template’s markdown files with your own. - To change the design, edit the
.scss
files for each output format: set project-wide styles in_sass
, and book-specific styles inbook/styles
. We suggest making all modifications in_sass/theme
.
There is much more detail in the docs.