Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Book publishing as easy as it should be (built with Symfony components)
branch: master

Fixed an error with headers for books published as 1-page-per-chapter

When the chunk_level of a book published as a website is 1, each chapter
is published in one page. <h1> and <h2> headers were correctly published
but <h3> .. <h6> headers weren't properly published because they lacked
the `id` attribute.

Now all the headers are correctly generated regardless of their level.
latest commit 9046ace5eb
Javier Eguiluz authored
Failed to load latest commit information.
app Fixed the ePub toc.ncx template
doc Fixed the documentation about disabling labels
src/Easybook Fixed an error with headers for books published as 1-page-per-chapter
.gitignore Added new resources to the documentation
.travis.yml Added PHP 5.6 and HHVM to the Travis continuous server
CONTRIBUTORS.md Fixed a typo in the name of the "outter" property
LICENSE.md The new license of the project is pure MIT license
README.md Updated some README file contents
UPGRADE.md Normalized Markdown headers before parsing the book contents
book
composer.json Replaced the Slugger class by the new easybook/slugger library
phpunit.xml Added a bunch of unit tests (code coverage: 81%)

README.md

easybook

«book publishing as easy as it should be»

easybook lets you easily publish books in various electronic formats (ePub, MOBI, PDF and HTML). It was originally designed to publish programming books, but you can use easyboook to publish any kind of book, manual or documentation website.

easybook worflow diagram

Installation

easybook can be installed in three different ways depending upon your needs:

  1. ZIP installation: best suited for users who want to try easybook features as fast and easy as possible.
  2. Composer installation: recommended for regular users who want to use easybook for publishing books and documentation.
  3. Git installation: reserved for advanced developers who want to hack and modify easybook.

Regardless the way you install it, use easybook with the book command:

$ cd <easybook-installation-dir>
$ ./book

If the last command doesn't work, try php book or check book script permissions.

1. ZIP installation

  1. Download easybook.zip file.
  2. Uncompress easybook.zip file in any directory.

2. Composer installation

Execute the following command to install easybook and all its dependencies in 'easybook' directory:

$ php composer.phar create-project easybook/easybook easybook

This method requires that Composer is previously installed on your system. You can install it simply by executing the following command:

$ curl -s http://getcomposer.org/installer | php

3. Git installation

// clone easybook repository
$ mkdir easybook
$ git clone http://github.com/javiereguiluz/easybook.git easybook

// download vendors and dependencies
$ cd easybook
$ php composer.phar install

This method requires that Composer is previously installed on your system. You can install it simply by executing the following command:

$ curl -s http://getcomposer.org/installer | php

Documentation

easybook is fully documented at http://easybook-project.org/documentation

License

easybook is licensed under the MIT license.

Tests

Execute the following command to test easybook (requires PHPUnit):

$ cd <easybook-installation-dir>
$ phpunit

Code Quality Assurance

SensioLabs Insight Travis CI Scrutinizer CI
SensioLabsInsight Travis CI status Scrutinizer Quality Score Code Coverage

Requirements

In order to generate PDF files, PrinceXML library must be installed. If you haven't installed it yet, you can download a fully-functional demo at:

http://www.princexml.com/download

In order to generate MOBI files, KindleGen library must be installed. If you haven't installed it yet, you can download it freely at Amazon:

http://amzn.to/kindlegen
Something went wrong with that request. Please try again.