letterpress/README.md
2024-07-07 18:31:08 +02:00

1.2 KiB

letterpress

Gutenberg the 💩 out of it!

Tools

This Project makes use of the following tools:

Batteries included

Everything you need to get started is included in the package

  • Devcontainers: Allows you to build your book locally
  • GitHub Workflows: Allows you to build your book on GitHub CI

Bring your own

  • Content
  • Images

Commands

Generate

In order to generate the PDF and the EPUB versions of the book you can just run:

make

If you just need to generate the PDF:

make output/your_book_slug.pdf

If you just need to generate the EPUB:

make output/your_book_slug.epub

Count

make count

Clean

In order to remove the generated files you can run:

make clean

Structure

The entry point of the book is book.adoc.

The book.adoc consists of 3 sections:

The body is where should be placing the main content of your book.