hochanh / book-skeleton

Skeleton project for an Asciidoctor-based e-book

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Book Skeleton

This is a skeleton project for an e-book project written in AsciiDoc.

The project is set up for a multi-chapter book, with a cover image, and syntax highlighting of code blocks. It has a custom theme to controls fonts and spacing.

The project uses asciidoctor-epub and asciidoctor-pdf to generate EPUB and PDF versions of the book.

Getting started

For Apple Sillicon

brew install ruby export PATH=/usr/local/opt/ruby/bin:$PATH export PATH=gem environment gemdir/bin:$PATH

The project dependencies are Ruby libraries, and can be installed using Bundler:

bundle install

Then you can build both book targets using the Makefile:

make

Alternatively, you can make pdf or make epub to build a single target.

Writing content

The AsciiDoctor Writer's Guide is a nice introduction to writing content in AsciiDoc. Once you're familiar with the basics of that, you can start adding chapters in the ./chapters folder, and include them in the main.adoc file.

About

Skeleton project for an Asciidoctor-based e-book

License:MIT License


Languages

Language:Ruby 76.0%Language:Makefile 24.0%