wieerwill/letterpress
1
0
Fork 0
mirror of https://github.com/dunyakirkali/letterpress.git synced 2025-07-03 23:15:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Gutenberg the 💩 out of it!
40 Commits 4 Branches 5 Tags 27 MiB
Makefile 100%
cac7d5a0ff
Go to file
Dunya Kirkali cac7d5a0ff Fix figure issue
2024-09-06 20:43:03 +02:00
.devcontainer Switch to official docker image 2024-09-06 19:47:20 +02:00
.github Add Makefile 2024-07-07 23:05:26 +02:00
backgrounds Add main structure 2024-06-24 07:23:43 +02:00
figures Fix figure issue 2024-09-06 20:43:03 +02:00
source Move book.adoc to root 2024-09-06 19:47:31 +02:00
.editorconfig Add editorconfig 2024-06-15 10:51:17 +02:00
.gitignore Fix figure issue 2024-09-06 20:43:03 +02:00
book.adoc Enable kroki 2024-09-06 18:27:54 +00:00
LICENSE Create LICENSE 2024-07-07 00:17:48 +02:00
Makefile Fix figure issue 2024-09-06 20:43:03 +02:00
metadata.yaml Update metadata 2024-07-07 18:27:10 +02:00
README.md Move book.adoc to root 2024-09-06 19:47:31 +02:00

README.md

letterpress

Gutenberg the 💩 out of it!

Letterpress is a project aimed at simplifying the self-publishing process for books. It provides a ready-to-use template based on AsciiDoctor, catering to authors who need robust support for diagramming, coding examples, and mathematical formulas.

Contributing

Contributions to Letterpress are welcome! If you have suggestions, improvements, or bug fixes, please fork the repository and submit a pull request.

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/book.pdf

If you just need to generate the EPUB:

make output/book.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.