https://github.com/pseudomuto/bookery

A simple gem to help with authoring books
https://github.com/pseudomuto/bookery

Last synced: 7 months ago
JSON representation

A simple gem to help with authoring books

• Host: GitHub
• URL: https://github.com/pseudomuto/bookery
• Owner: pseudomuto
• License: mit
• Created: 2013-12-08T00:49:43.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-01-06T17:10:49.000Z (over 12 years ago)
• Last Synced: 2025-10-21T04:10:52.205Z (8 months ago)
• Language: Ruby
• Size: 402 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bookery

[![Build Status](https://travis-ci.org/pseudomuto/bookery.png)](https://travis-ci.org/pseudomuto/bookery)

[![Gem Version](https://badge.fury.io/rb/bookery.png)](http://badge.fury.io/rb/bookery)

[![Code Climate](https://codeclimate.com/github/pseudomuto/bookery.png)](https://codeclimate.com/github/pseudomuto/bookery)

My own (very opinionated) custom tool for writing books. This is very much a work in progress right now.

## TODO's for a reasonable v1

* [ ] Build PDF

* [ ] Build Mobi

* [ ] Build ePub

## Installation

    $ gem install bookery

_If you're using rbenv, run `rbenv rehash` after the installation to ensure the shim is created_

## Creating a New Book

    $ bookery new 

This will create a new [project] in the specified directory.

## Publishing

From within the project directory:

    $ bookery publish

This will generate an HTML version of your book for each language in the [project].

## Editing

For a guideline on editing, checkout the [editing] docs.

## Contributing

Wanna contribute? Awesome! Check out the [contributing guidelines] to get started.

[project]: docs/project.md

[editing]: docs/editing.md

[contributing guidelines]: docs/contributing.md