Blitz eBook Framework
An eBook framework (CSS + template) whose mantra is “finding simple solutions to complex issues.”
All the Blitz repositories reached End Of Life on July 1, 2020. The entire project is no longer maintained and its repositories are read-only. You can still fork them if they can be useful to you.
Blitz is released under MIT Licence © 2016, Jiminy Panoz.
- Readium SDK
- Adobe RMSDK
- Google Play Books
- Kindle (mobi7 + KF8)
How to Use
There are various ways to use blitz, from adding the available stylesheets (
CSS folder) to building them with the LESS framework.
Use the Provided Stylesheets
You can either add
blitz.css or an alternative stylesheet in your EPUB file.
blitz.css is commented but you’ll find an uncommented version in the
AltStylesheets folder (which helps you save some 7kb).
In this folder, you’ll also find
blitz-reset.css (normal + minified).
blitz-lite.cssshould be enough for simple books like novels and essays (it’s 3kb);
blitz-reset.cssis just… the reset we’ve designed (it’s 1kb).
Add styles on top of those two is up to you… But you’ll then miss the powerful tools we’ve built in LESS!
Install and Compile With npm
First go to the blitz root directory and install the dev dependencies:
Then make your changes in LESS and run:
npm run build
This will compile the LESS src to the default, lite and reset stylesheets, and update the template.
If you want to compile only one stylesheet you can run:
build:defaultfor the default output (
blitz.css) – that will update the template’s unzipped src too;
build:litefor the lite output (
build:resetfor the reset output (
All those sub-builds will generate uncommented/minified files as well.
Finally, to update the packaged EPUB file then use
npm run make.
Compile LESS Sources Without npm
Either use the GUI or, if you’re one of the old-school type…
lessc Blitz_framework/LESS/blitz.less Blitz_framework/CSS/blitz.css
lessc Blitz_framework/LESS/blitz-lite.less Blitz_framework/CSS/AltStylesheets/blitz-lite/blitz-lite.css
lessc Blitz_framework/LESS/blitz-reset.less Blitz_framework/CSS/AltStylesheets/blitz-reset/blitz-reset.css
Related Blitz Tools
- Blitz Tasks – a set of gulp scripts to automate (X)HTML markup changes and apply some useful optimizations
- blitzck-cli – EPUB Reading Systems’ support, mimetypes, namespaces, and ARIA mappings from the command line interface
- Blitz Checklist – A template repository to make checklist web apps (it’s the tiny little engine that powers the BlitzOptim and BlitzPerf web apps)
- The eBook Design Checklist – a progressive web app to help you design eBooks
- The eBook Performance Checklist – a progressive web app to help you boost eBook performance
- Blitz eBook Tricks – a collection of CSS snippets to help you do progressive enhancement in eBooks
Design & Goals
Blitz was designed to deal with the significant obstacles a newcomer or even an experienced producer might encounter. Its major goals are:
- to be simple and robust enough;
- to offer a sensible default;
- to manage backwards compatibility (ePub 2.0.1 + mobi 7);
- to provide useful tools (LESS);
- to get around reading modes (night, sepia, etc.);
- to not disable user settings.
We have chosen a functional approach (FCSS) but LESS presets are planned to provide meaningful class names depending on eBook’s type (poetry, plays, etc.).
The 4 Principles of Blitz
- Espouse inheritance and the cascade, the 2 fundamental principles of CSS. eBooks are documents, CSS was designed for documents… It’s a match!
- Build and refine, don’t style and undo. Don’t override your own styles, create reusable components—the reset should help you do that.
- Don’t fight, skirt. Be smart, it’s not worth fighting RS’ default stylesheets (their selectors and !importants are too much hassle), trompe le monde.
- Have fun! We’ve done our utmost to help you avoid common pitfalls. You don’t have to deal with the crappiest parts of eBook CSS authoring, sit back and relax.
Blitz is leveraging the concept of inheritance. Values
currentColor are being used extensively to make the framework compatible with Reading Systems’ default stylesheets, reading modes (
color) and user settings (
Defaults and a reset do the heavy lifting so it’s just about building on top of this base. Please note Blitz is taking care of defaults RS aren’t necessarily (HTML5 block elements, hyphens and pagebreaks for selected elements, etc.).
Finally, although we try to rely on RS’ typefaces, typography has been fine tuned.
- The default scale has been chosen to handle various situations well enough (screen/container size, user increasing
font-size, typeface used, etc.)
- Vertical rhythm (
padding) is automatically computed in LESS to enforce consistency. By taking care of vertical rhythm, we’re also achieving horizontal harmony when the eBook is rendered on a (fake) spread: “everything text” lines up on the same baseline grid, which makes for a more comfortable reading experience.
substyling is improved to prevent them from affecting line-height.
- The whole §8. Breaking Within Words is implemented in LESS.
To sum up, we’ve tried to find a balance and feel like Blitz defaults can help producers get around a lot of possible issues: we don’t need hacks, we don’t have to change values in specific situations using complex media queries.
Related EPUB 3.1 issues
- The EPUB 3.1 spec should address common reader styling scenarios #671
- Defining a minimal default stylesheet in the epub spec #672
- Media Queries #685
- Possible spec language for reading system CSS handling #693
Browserlist we’re using for progressive enhancements
ie >= 11 edge >= 14 last 4 chrome major versions safari >= 9.1 ios_saf >= 9.3 android >= 4.4 last 2 and_chr major versions
Alternatively, you can use this CanIuse Link.
When checking for support, you can simply click “Apply Filters” in order to display those browsers in the support table.
Some more details
- IE 11’s Trident is used by some Windows app like Adobe Digital Editions 4.5
- Edge is aligned with the release of the eBook Reader in the Edge browser
- Safari on MacOS is aligned with the release of iBooks on Mavericks (10.9)
- Safari on iOS is starting at iOS 9.3
- Android 4.4.4 is still used by some apps on Android while others are using the more modern WebView (2 last Android versions)
Frequently Addressed Questions
Is this project still active?
Blitz was sunset in 2020. As of July 1, 2020 the entire project is no longer maintained and its repositories read-only. You can still fork them.
We deemed Blitz feature-complete though, and it should consequently be still useful for a couple of years.
Has anyone funded this project?
At some point, sponsoring was considered but quickly dismissed due to the relatively small size of the ebook production community: it was simply too much to ask.
Which features did not make it into the framework?
Quite a lot, actually.
- Building an online CSS generator in the form of a website where people would answer questions, and a stylesheet would be created based on those answers.
- Presets for different genres of books.
- Poor man’s Dev Tools.
- Automated scripts to update ePub2 files to EPUB3, convert
epub:typeto DPUB ARIA, clean DTP outputs’ markup, etc. (would have required GUI since everyone is not comfortable with the command-line and npm).
- A CanIUse-like service.
But maybe you could successfully build a business out of that list…
What is missing in version 1?
By improving support for the 24 additonal languages we added at some point, Blitz would better cover the needs and requirements of 3,049,150,507 speakers.
Why was JS abandoned?
A library of custom elements almost happened after successful initial testing, but one careful review later, it was clear most authors wouldn’t even bother trying such a library. That wasn’t a hill to die on when most authors want Reading Systems to handle that out of the box.
How to leverage the LESS meta-language?
- Guarded header comment so that it’s output in all stylesheets (to make it a little bit easier for DAISY WordToEPUB)
- Created a
.line-throughstatic mixin in utilities
- Improved consistency of mixin usage in LESS
With massive props to @ptmkenny for internationalization and config improvements.
- Improved and completed
- Implemented ruby text in default for Japanese
min-light-heightas a variable (for Kindle)
- Implemented a font-family variable for a custom headings selector
- Fixed list style type for Kindle
- Made asterism path a global variable
- Made link color a separate variable
- Made font stacks global variables so that they can be reused in the codebase
- Made Kindle output a flag users can enable/disable (
padding-leftfor lists (switched to relative
ems) so that markers can’t be cropped
- Added internationalization reference to the LESS framework
- Moved Kindle Media Queries and styles into core
- Removed other MQs
- Corrected tables’ cell padding (switched back to
pxvalue instead of
%as it depended on RSs’ forcing a relayout)
- Disabled a11y metadata in an attempt to provide a reasonable default
- Corrected KF8’s bug where
page-break-inside: avoidcan create a blank
- Corrected Mobi7 font size for
.small-capsand created a new
- Progressive enhancements plugin is now implemented at the core of the LESS framework:
- Automated build with npm
- Removed gap after images
- Added DPUB ARIA roles in template
- Fixed hyphenation (limit chars)
- added reset styles for
hiddenattribute to improve backwards compatibility;
- added a utility for
- an experimental plugin for progressive enhancements is now available (check docs).
- Added plugin for progressive enhancements.
hr.transition(won’t screw up vertical rhythm because margins any longer);
-webkit-localenow an override (issue #9).
0.9.5 (Pre-release) -> 1.0.0 (stable)
- refacto making the framework much easier to handle and customize (typo is now barebones)
- asterism is now an SVG background (beware! it’s an external dependency)
- CSS has been fine-tuned (e.g.
limit-lines, tabular numerals,
- added mixins to override and customize
- prevented blank page at the end of xhtml in reset
- initialized docs (vanilla docs + API flavored reference)
- containers’ and images’ classes in
vhare now available
- corrected epub namespace
- completed utilities (margins, underline, etc.)