Skip to content
This repository has been archived by the owner on Jan 10, 2021. It is now read-only.

1. Requirements & installation

Jump to bottom
C Tarwater edited this page Jun 8, 2017 · 3 revisions

Requirements

I recommend using our Dockerfile to build the Docker container since it'll have all the tools you need, but if you want to install everything locally Open-Publisher needs the following software and tools to installed in order to work:

Ruby 2.x

Jekyll requires ruby so you'll need a working Ruby installation.

Jekyll

Jekyll - a static site generator. For our purposes it is used to combine multiple markdown files into a single markdown file.

Pandoc

Pandoc - converts from many file formats to many other file formats. For our purposes, it converts our markdown file to epub and pdf.

Kindlegen

KindleGen - Amazon's free tool to create .mobi/kindle files. For our purposes it converts epub to mobi.

LaTeX / TexLive

LaTeX - typesetting software that can output PDF files.

Installation

How to Use Docker (recommended)

docker run -v $PWD/input:/Open-Publisher/Source -it ctarwater/open-publisher rake skel

How to Install Everything Locally

  1. First, make sure you've read the Requirements page.
  2. Git clone the Open-Publisher repo.
  • git clone https://github.com/chrisanthropic/Open-Publisher
  1. Install the required Ruby Gems. Change into the repo you just cloned and run:
  • bundle install --binstubs --path=vendor
Clone this wiki locally