mirror_php/ibis
1
0
Fork 0
mirror of https://github.com/themsaid/ibis.git synced 2025-01-16 13:09:27 +01:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Mohamed Said 2020-11-04 16:25:55 +02:00
parent 593d425024
commit fc7858178d
2 changed files with 81 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE.md Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) Mohamed Said <themsaid@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

64
readme.md
View File

@ -1,6 +1,16 @@
# Ibis Book Maker
First run this command inside your project root:
## 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
@ -9,16 +19,62 @@ 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.
You may configure your book by editing the `/ibis.php` configuration file.
Inside the content directory, you can write multiple `.md` file and then run:
## 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.
```
## Generating PDF eBook
```
ibis build
```
Ibis will parse the files in alphabetical order and store the PDF file in `/export`.
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.