Skip to content

WIP: WIP: WIP: Generate a downloadable handbook file

Nick Thomas requested to merge nick.thomas/www-gitlab-com:handbook-epub into master

This is extremely WIP, but @tiagonbotelho was interested in the context of #689 so I thought I'd share early. It also has some relevance to #764 (closed).

Generate an EPUB of the handbook from existing .md files. I prefer EPUB to PDF because most eBook readers have text reflow support for the former, but not the latter. Generating it also has fewer dependencies.

A 'generate PDF from EPUB' job is trivial if we need it.

There are many outstanding issues with the generated output. Things I've noticed so far:

  • Missing images like https://github.com/jgm/pandoc/issues/1450
  • Pandoc doesn't support all markdown extensions we use
  • Needs a funky cover image
  • Many internal links don't work
  • Many warnings like this in the generated output:

Screen_Shot_2016-08-17_at_23.17.45

Even with all that, having this file in my desktop ebook reader is pretty handy. It'd be handier if I could update my local copy automatically every time something gets merged to master.

Here's an example of what it generates so far:

handbook.epub

Merge request reports

Loading