Electric Book documentation

Quick start

These docs explain how to set up the Electric Book template, how to edit book files, and how to output books. The template includes these docs, which you can turn off in _config.yml.

If you are using the Electric Book Manager, you may also need the Electric Book Manager documentation.

These docs are a work in progress, and not everything is documented yet. You can contribute on GitHub, or let us know about problems by logging issues.

• About
  • About the EBW
  • Technical overview
• Setup
  • Quick start
  • Setting up your computer
  • Setting up a book
  • Settings
  • Project metadata
  • Navigation and TOCs
  • File lists
  • Tracking and analytics
  • Translations
  • Search indexes
  • Variants
  • Updating project files
• Editing
  • Markdown
  • Content tags (classes)
  • Images
  • Tables
  • Figures
  • Slides
  • Footnotes, endnotes and sidenotes
  • Hyphenation
  • Mathematics
  • Poetry
  • Indexes
  • Video
  • Questions and quizzes
  • Redaction
  • Show-hide buttons
• Images
  • Adding image files
  • Automating image conversions
  • External media
  • Preparing images
  • Adding a favicon
• Layout
  • Design
  • Page numbers
  • Web and app pagination
  • Web and app content accordion
  • Colour profiles
• Output
  • Web output
  • PDF output
  • Epub output
  • App output
  • Word output
• Advanced
  • Using Javascript
  • Packaging the project
• Troubleshooting
  • Troubleshooting and tips