wieerwill/letterpress
1
0
Fork 0
mirror of https://github.com/dunyakirkali/letterpress.git synced 2025-01-22 19:38:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Gutenberg the 💩 out of it!
33 Commits 4 Branches 3 Tags 27 MiB
Makefile 100%
cc113ef2aa
Go to file
Dunya Kirkali cc113ef2aa Better devcontainer
2024-07-07 23:02:53 +02:00
.devcontainer Better devcontainer 2024-07-07 23:02:53 +02:00
.github Create FUNDING.yml 2024-07-07 00:15:08 +02:00
backgrounds Add main structure 2024-06-24 07:23:43 +02:00
figures Improve example 2024-07-07 23:02:46 +02:00
source Improve example 2024-07-07 23:02:46 +02:00
.editorconfig Add editorconfig 2024-06-15 10:51:17 +02:00
.gitignore Add gitignore 2024-07-07 22:38:05 +02:00
LICENSE Create LICENSE 2024-07-07 00:17:48 +02:00
metadata.yaml Update metadata 2024-07-07 18:27:10 +02:00
README.md Update README 2024-07-07 18:31:08 +02:00

README.md

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.