59ff4fc3a3
Backported from em_book's CI. Adds a 'make epubcheck' target that builds the EPUB (via its dependency) and validates it with EPUBCheck, so authors can catch EPUB issues locally before publishing. - New epubcheck target depending on the EPUB path - Document it in the README - Add .PHONY declarations Co-authored-by: Dunya Kirkali <exedev@writting.exe.xyz> Co-authored-by: Shelley <shelley@exe.dev>
2.2 KiB
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
Validate EPUB
letterpress can validate the generated EPUB with EPUBCheck. Once you've installed EPUBCheck on your machine you can run it with:
make epubcheck
This builds the EPUB (if needed) and then validates it.
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 front matter
- The body
- The back matter
The body is where should be placing the main content of your book.