Skip to content

asciibook/asciibook

Repository files navigation

Asciibook

Asciibook is an Ebook generator for converting AsciiDoc to HTML, PDF and EPUB.

Installation

Asciibook uses docker as distribution tool. Docker helps deal with dependencies, keeps the local environment clean, and works well with CI / CD tools.

You can download and install docker in https://www.docker.com/products/docker-desktop .

After installed docker, Pull the docker image:

$ docker pull asciibook/asciibook

Usage

First, enter container enviroment in your AsciiDoc file diretory:

$ docker run -it -v $(pwd):/asciibook asciibook/asciibook bash
/asciibook #

Following command is executed inside the container environment.

For a existing AsciiDoc file, run this command to build all formats:

/asciibook # ascibook build mybook.adoc

Generated results will be placed in the build folder.

Or generate partial formats:

/asciibook # asciibook build mybook.adoc --format html,pdf,epub

If you don’t want to type the parameters repeatedly, you can create a configuration file for the document:

/asciibook # asciibook init mybook.adoc

It will create a config file named asciibook.yml in the same directory, edit config for your need, then use this command to build next time:

/asciibook # asciibook build

Development

Clone this repo:

$ git clone https://github.com/asciibook/asciibook.git
$ cd asciibook

Star dev environment with docker:

$ docker-compose run console

Run test:

/asciibook # rake test

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/asciibook/asciibook.

License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).