For many years I was struggling every time I was using a someone else’s engine to build one of my sites. I’ve tried WordPress, Koken, Aegea, Django, DocPad and Hexo. Now all my personal sites (this blog, homepage and photo portfolio) work on my own static site generator — Fledermaus — and I’ve never been more happy.
It’s not my first engine:
- fjSiter, 2002: PHP, MySQL, XSLT based content management system.
- Custom PHP based generator for my photo gallery, 2008.
- Sweet, 2011: Node based static site generator.
- Springhare: Python based gallery engine, unfinished (the project was too big for one developer with limited time).
- Others that I don’t remember.
Experience with other engines has taught me how an engine shouldn’t be implemented.
Usual site engine is a massive piece of code that’s optimized for a few the most popular use cases. But if you want something else you have to suffer: it’s either too hard or not possible at all. Often you end up with an ugly unstable code that breaks after every engine update.
It’s like in Joe Armstrong’s famous saying about object-oriented programming:
You wanted a banana but what you got was a gorilla holding the banana and the entire jungle.
But in that case the banana is half-eaten.
With the Fledermaus I took a different approach. Actually it’s just a collection of useful functions that you can use to write your own static site generator: loading Markdown source files, documents filtering, grouping and sorting, pagination, internationalization, generating HTML pages and RSS, and so on
You can combine them any way you want, add custom processing at any step, generate pages yourself. For example, in my photo gallery I read EXIF metadata from JPEG files and generate pages (/albums/dogs/2013-08-03-3733
) and albums (/albums/dogs
) based on this data.
It’s based on fancy modern things like ECMAScript 2015, JSX, Markdown and Intl.
And it’s very small and fast:
Engine code
Docpad: 10300 lines (without 6 required plugins)
Hexo: 7800 lines (without 2 required plugins)
Fledermaus: 1300 lines
Blog code
Docpad: 211 lines
Hexo: 361 lines
Fledermaus: 159 lines
Build time
Docpad: 77,49s (version 6.78.4)
Hexo: 4,60s (version 3.1.1)
Fledermaus: 3,80s (version 5.0.1, including Babel transpilation)
It builds my whole photo gallery (2000 HTML pages) in 35 seconds on my 2011 MacBook Pro.
Now I finally can build stuff instead of crutches.