enlight/scratch

Markdown to PDF book builder

v1.0.0 2022-03-06 13:50 UTC

This package is auto-updated.

Last update: 2022-08-06 14:49:45 UTC


README

THIS IS WELL MAINTAINED FORK OF THEMSAID/IBIS PROJECT.

This PHP tool helps you write eBooks in markdown. Run scratch build and an eBook will be generated with:

  1. A cover photo.
  2. Clickable auto-generated table of contents.
  3. Code syntax highlighting.
  4. Available in 2 themes. Light and dark.

Installation

Make sure you have PHP7.3 or above installed on your system and that your gd extension is enabled in your php.ini file.

First, install the composer package globally:

composer global require enlight/scratch

Then, run this command inside an empty directory:

scratch init

This will create the following files and directories:

  • /assets
  • /assets/fonts
  • /assets/cover.jpg
  • /assets/theme-light.html
  • /assets/theme-dark.html
  • /content
  • /scratch.php

You may configure your book by editing the /scratch.php configuration file.

Writing Your eBook

The init command will create sample .md files inside the content folder. You can explore those files to see how you can write your book. This sample content is taken from Laravel Queues in Action.

Inside the content directory, you can write multiple .md files. Scratch uses the headings to divide the book into parts and chapters:

# Part 1

<h1> tags define the start of a part. A separate PDF page will be generated to print the part title and any content below.

## Chapter 1

<h2> tags define the start of a chapter. A chapter starts on a new page always.

### Starting with Scratch

<h3> tags define different titles inside a chapter.

Using images

Images can be stored in the content folder and then brought in like this:

![Screenshot 1](content/screenshot-1.png)

Adding a cover image

To use a cover image, add a cover.jpg in the assets/ directory (or a cover.html file if you'd prefer a HTML-based cover page). If you don't want a cover image, delete these files.

Using Fonts

Edit your /scratch.php configuration files to define the font files to be loaded from the /assets/fonts directory. After that you may use the defined fonts in your themes (/assets/theme-light.html & /assets/theme-dark.html).

Generating PDF eBook

scratch build

Scratch will parse the files in alphabetical order and store the PDF file in /export.

The default is to generate the PDF using the light theme, to generate a PDF using the dark theme:

scratch build dark

Generating A Sample

scratch sample

scratch sample dark

This command will use the generated files from the scratch build command to generate samples from your PDF eBook. You can configure which pages to include in the sample by updating the /scratch.php file.

Development

This project uses PHP CS Fixer with a code standard defined in .php-cs-fixer.php.

To review code out of style, you can run the fix command as a dry run. Run the composer script like this:

composer run csfix-review

To fix the source code, run the following composer script:

composer run csfix

Credits

License

The MIT License (MIT). Please see License File for more information.