google-sre-ebook/README.md
Caleb Mingle 2ff063e9b3 Add support for building eBook with Docker
This change adds support for building the eBook with Docker. Supporting Docker means
that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their
environments.

I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all
ears.

Build tested on Linux. Outputs were fine.

There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0]
in their latest versions.

[0] - https://pandoc.org/MANUAL.html#extension-smart
2018-05-15 10:41:05 -07:00

44 lines
723 B
Markdown

# google-sre-ebook
![Cover](cover.jpg)
Generates a EPUB/MOBI for the Google SRE Book.
Original sources are downloaded from https://landing.google.com/sre/
# Build
## macOS
Review and run the `bootstrap.sh` script to generate the EPUB and MOBI files
Requirements:
- Ruby
- gem install bundler
- gem install nokogiri
- brew install pandoc
- brew cask install calibre
- brew install wget
## Docker
Requirements:
- Docker
```
$ ./build_docker.sh
```
# Known Issues
- Inline references are not handled in the best possible way
- metadata.xml is not complete. There are just too many authors
- Foreword/Preface is not part of the index
# LICENSE
This is licensed under WTFPL. See COPYING file for the full text.