-
Notifications
You must be signed in to change notification settings - Fork 24
How to use with docker
(Requires you to have Docker installed)
- Git clone open-publisher repo
https://github.com/chrisanthropic/Open-Publisher.git
- Build the container
docker build -t open-publisher .
First create the contents of our Example book:
docker run -v $PWD/input:/Open-Publisher/Source -it open-publisher rake skel
Now create the actual books: This will create two new directories (input & output) which are mounted inside the Docker container. input maps to Source and output maps to Books. Running this command will create all versions of the example book which you can see in output.
docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake all[all]
Open the "Books" directory to see the results.
Create example book (This will move the contents of 'skel' to 'Source')
Use Rake to create a new book. It creates everything needed and puts it in the right places so that you can just write.
Run the command docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake build and enter the title of your book when prompted.
Paste your manuscript in Source/_includes/$BOOK-TITLE/chapters.md
The beginning of your Source/_includes/$BOOK-TITLE/chapters.md contains "YAML Front Matter" and is used to define metadata about your book that we use in various places for various templates. Anything with an asterisk is optional.
---
title: Title of your book
subtitle*: Optional subtitle
author: Author Name
website: Author Website
type: Genre of your book
lang: A string value in BCP 47 format: http://tools.ietf.org/html/bcp47 (example: en-US)
date: YYYY-MM-DD
year: YYYY
cover-image: Source/images/YOUR-IMAGE.jpg
publisher: Publisher of your book
rights: A single sentence regarding the licensing of your book
isbn*: Optional ISBN of your print book
isbn-13*: Optional 13 digit ISBN of your print book
epub-isbn*: Optional ISBN of your epub
dedication: Optional dedication.
identifier:
- scheme: UUID
text: A unique UUID for your ebook.
contributors*:
- designer*: Who designed your book/cover
artist*: Who created the art of your book cover
editor*: Who edited your book
book1*:
- title*: Optional books to include on the title page
link*: If you include Amazon links here, they'll get linked in the Amazon version
book2*:
- title*: Add a second book
link*: http://www.amazon.com/dp/B0090NFRY2
book3*:
- title*: This handles up to 5 books
link*: http://www.amazon.com/dp/B00HE5I1BE
review*:
- amazon*: https://www.amazon.com/review/create-review?asin=B007UIYEAW | Optional Amazon url to review your book.
magnet*:
- image*: ../Images/file0.jpg | optional image/url to add to the front matter of your ebooks to get people to join your newsletter
link*: https://www.backthatelfup.com/free-books/
---
Open-Publisher uses three 'common' pages by default which are shared between all books. These pages will need to be customized with your information.
Customize the contents of Source/_includes/amazon_review.md, Source/_includes/bio.md, and Source/_includes/license.md.
-
Amazon Review: This page is used for our Amazon template and is added to the last page of the book immediately following the ending. We use it to kindly request that the reader consider leaving a review and provide a link to the Amazon page where they can easily do so.
-
Bio: This page is used as a bio page for more information about the author.
-
License: This is the license page. We default to the Creative Commons Attribution-NonCommercial-ShareAlike license because that's what we personally use. Feel free to modify it to your preferred license.
- NOTE: Due to technological limitations the license page here IS NOT used when creating a print-ready PDF which uses it's own license page as defined in the LaTeX template at
Pandoc/templates/cs-5x8-pdf.latexin the "Create a copyright page" block.
- NOTE: Due to technological limitations the license page here IS NOT used when creating a print-ready PDF which uses it's own license page as defined in the LaTeX template at
Use Rake script to create your books by running docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake $FORMAT[$TITLE]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake all[Example]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake epub[Example]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake amazon[Example]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake smashwords[Example]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake pdf[Example]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake print[Example]
Open-Publisher can easily handle multiple books.
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake all[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake epub[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake amazon[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake smashwords[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake pdf[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake print[all]
Run docker run -v $PWD/input:/Open-Publisher/Source -v $PWD/output:/Open-Publisher/Books -it open-publisher rake destroy and enter the title of your book when prompted.