ibis/readme.md

# Ibis Book Maker

This PHP tool helps you write eBooks in markdown. Run `ibis build` and an eBook will be generated with a cover and clickable table of contents. 

## Installation

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.

## Writing Your eBook

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.
``` 

## Using Fonts

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`).

## Generating PDF eBook

```
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
```

## Generating A Sample

```
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.

## Credits

- [Mohamed Said](https://github.com/themsaid)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
Init 2020-11-04 16:03:50 +02:00			`# Ibis Book Maker`

update readme 2020-11-04 16:29:43 +02:00			This PHP tool helps you write eBooks in markdown. Run `ibis build` and an eBook will be generated with a cover and clickable table of contents.

update readme 2020-11-04 16:25:55 +02:00			`## Installation`

			`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:`
Init 2020-11-04 16:03:50 +02:00
			```
			`ibis init`
			```

			`This will create the following files and directories:`

			`- /assets`
update readme 2020-11-04 16:25:55 +02:00			`- /assets/fonts`
Init 2020-11-04 16:03:50 +02:00			`- /assets/cover.jpg`
update readme 2020-11-04 16:25:55 +02:00			`- /assets/theme-light.html`
			`- /assets/theme-dark.html`
Init 2020-11-04 16:03:50 +02:00			`- /content`
			`- /ibis.php`

update readme 2020-11-04 16:25:55 +02:00			You may configure your book by editing the `/ibis.php` configuration file.

			`## Writing Your eBook`

			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.`
			```
Init 2020-11-04 16:03:50 +02:00
update readme 2020-11-04 16:29:43 +02:00			`## Using Fonts`

			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`).

update readme 2020-11-04 16:25:55 +02:00			`## Generating PDF eBook`
Init 2020-11-04 16:03:50 +02:00
			```
			`ibis build`
			```

update readme 2020-11-04 16:25:55 +02:00			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`
			```

			`## Generating A Sample`

			```
			`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.

			`## Credits`

			`- [Mohamed Said](https://github.com/themsaid)`
			`- [All Contributors](../../contributors)`

			`## License`

			`The MIT License (MIT). Please see [License File](LICENSE.md) for more information.`