Artwork by Eric L. Barnes and Caneco from Laravel News ❤️.
This PHP tool helps you write eBooks in markdown. Run ibis build
and an eBook will be generated with:
- A cover photo.
- Clickable auto-generated table of contents.
- Code syntax highlighting.
- Available in 2 themes. Light and dark.
Here's a sample PDF eBook generated with Ibis: click me
Make sure you have PHP7.3 or above installed on your system.
First, install the composer package globally:
composer global require themsaid/ibis
Then, run this command inside an empty directory:
ibis init
This will create the following files and directories:
- /assets
- /assets/fonts
- /assets/cover.jpg
- /assets/theme-light.html
- /assets/theme-dark.html
- /content
- /ibis.php
You may configure your book by editing the /ibis.php
configuration file.
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.
Inside the content directory, you can write multiple .md
files. Ibis 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 Ibis
<h3> tags define different titles inside a chapter.
Edit your /ibis.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
).
ibis build
Ibis 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:
ibis build dark
ibis sample
ibis sample dark
This command will use the generated files from the ibis build
command to generate samples from your PDF eBook. You can configure which pages to include in the sample by updating the /ibis.php
file.
The MIT License (MIT). Please see License File for more information.