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
main
letterpress/README.md
Dunya Kirkali 1890774875
Enable vale for prose linting (#3) 
* Enable vale in CI

* Add vale config

* Tweak vale

* Update config

* Update .gitignore

* Switch back

* Rename CI

* Add badges

* Tidy up CI

* Change image

* Configure vale

* Delint

* Update README
2024-09-28 22:58:25 +02:00

1.9 KiB
Raw Permalink Blame History

letterpress

CI CD

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

Linting

letterpress comes with vale. Once you've installed vale on your machine you can run it with:

make lint

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.