Launch your best content today! Free and Open Source code to automate your ebook!
To create your own ebook is super simple: clone this project and start writing!
Getting Started in One Minute
Configure Your eBook
Although the project has lots of configuration, you just need to focus on the following topics:
Fill the file
automated-ebook.ascwith the right information. Here you will need to change the book name, author, and maybe the number of levels on the table of contents (
:toclevels:, the default is configured to 3).
At the same file, adjust chapters file names. You can add, remove or rename. You are in charge here.
Last but not least, create your chapters! The first chapter has lots of tips about how to deal with Asciidoctor syntax, but you can also check the documentation to get more details.
You can also change the file
cover.png with your own book cover. The size of this image is 1050x1600. You can use canva.com to create your design. It’s FREE. But the default size there is 1410x2250, so you will need to resize and fit after downloading (not a problem).
Generate Your eBook
To simplify things, let’s use Docker to automate book generation. Make sure you have it installed.
Each file from the eBook (HTML, Epub, Mobi e PDF) will be generated by using the image oficial image of Asciidoctor. Super easy!
Execute one of the following commands, according to your OS, on the project’s root folder:
# linux / unix docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor scripts/docker-startup.sh # others (change <path> with the full path of the current directory) docker run --rm -v <path>:/documents/ asciidoctor/docker-asciidoctor scripts/docker-startup.sh
Or use Docker Compose command to be able to type faster and avoid all parameters (already configured on
docker-compose run --rm ebook