Skip to content

Commit

Permalink
Updating stubs files
Browse files Browse the repository at this point in the history
  • Loading branch information
roberto-butti committed Sep 13, 2024
1 parent 1d8e22d commit 1445b49
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 24 deletions.
30 changes: 19 additions & 11 deletions stubs/content/001-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,35 @@ title: Introduction

# Ibis Next

{#id-cover-001 .image-container}
![Ibis Next Cover Image](../assets/images/ibis-next-cover.png)


## Create eBooks with Markdown

Are you a content creator looking to streamline your eBook creation process?
Look no further.
Ibis Next is your all-in-one solution, meticulously crafted to empower you in transforming your ideas into polished eBooks with unparalleled ease.
If you're a content creator seeking to simplify your eBook creation process, Ibis Next is here to help.

Designed as an all-in-one solution, Ibis Next makes it effortless to turn your ideas into well-crafted eBooks.

### What is Ibis Next?

Ibis Next is a PHP-based tool specifically designed to simplify the entire eBook creation journey. Leveraging the power of Markdown, it empowers users to focus on content creation while automating the complexities of generating professional-quality eBooks. Whether you're a seasoned author, a technical writer, or someone venturing into the world of eBook creation for the first time, Ibis Next is here to make the process seamless and efficient.
*Ibis Next*{style="color: red"} is a PHP-based tool designed to simplify the eBook creation process. By harnessing the power of Markdown, it allows users to focus on writing, while automating the more complex aspects of producing professional-quality eBooks. Whether you're an experienced author, a technical writer, or new to eBook creation, Ibis Next is here to make the process smooth and efficient.

### Key features

- **Markdown Magic**: Write your content using the simplicity and versatility of Markdown.
- **Automatic Generation**: Effortlessly create PDF or EPUB files with a single command using the `ibis-next pdf` command or `ibis-next epub`.
- **Aesthetic Appeal**: Elevate your eBooks with a professionally designed cover photo, a clickable auto-generated table of contents, and code syntax highlighting.
- **Theme Options**: Choose between two visually appealing themes - Light and Dark (theme support available for PDFs).
- **Markdown**: Write your content easily using the versatile Markdown format.
- **Automatic Generation**: Generate PDF or EPUB files with a single command, using `ibis-next pdf` or `ibis-next epub`.
- **Aesthetic Appeal**: Enhance your eBooks with a professionally designed cover, a clickable, auto-generated table of contents, and code syntax highlighting.
- **Theme Options**: Choose between two visually appealing themesLight and Darkfor PDF files.

### Why Choose Ibis Next?

Ibis Next eliminates the complexities of manual formatting, allowing you to concentrate on what matters most - your content. With Ibis Next, the once-daunting process of eBook creation becomes a smooth and enjoyable experience.
Ibis Next offers a powerful way to create digital books in EPUB and PDF formats. It enables writers to focus on crafting content without the need to worry about formatting. By utilizing Markdown, the process becomes simpler and more flexible.

Ibis Next efficiently manages the conversion process, ensuring a smooth transition from Markdown to EPUB and PDF formats. This approach streamlines writing, enhances collaboration, and makes editing easier, making it an excellent choice for authors who value efficiency and want to concentrate on their content.

This documentation serves as your guide to unlocking the full potential of Ibis Next. Whether you are a seasoned developer integrating Ibis Next into your workflow or a content creator exploring the possibilities, each section will provide insights, instructions, and best practices to ensure a seamless experience.
:::note
**Ibis Next** is an open-source tool, and you can contribute to the project by joining the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::

Get ready to revolutionize your eBook creation process with Ibis Next!
Get ready to revolutionize your eBook creation process with Ibis Next!
5 changes: 3 additions & 2 deletions stubs/content/002-installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ title: Installing Ibis Next

Before you begin, ensure that you have PHP 8.1 or above installed on your system, and make sure that the gd extension is enabled in your `php.ini` file.

>{notice} For more detailed information, refer to the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::note
For more detailed information, refer to the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::


### Installing ibis-next locally
Expand Down
59 changes: 49 additions & 10 deletions stubs/content/004-writing-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ This sample content is taken from [Ibis Next: create your eBooks with Markdown](
Inside the `content` directory, you can write multiple `.md` files. Ibis uses the headings to divide the book into parts and chapters:

~~~markdown

# 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.
Expand All @@ -24,26 +23,66 @@ Inside the `content` directory, you can write multiple `.md` files. Ibis uses th
`<h3>` tags define different titles inside a chapter.
~~~

### Adding different quotes
### Adding Aside
Inspired by the great Astro Starlight tool for creating technical documentation we support aside block.
Taking the definition from Astro Starlight documentation:
Asides (also known as “admonitions” or “callouts”) are useful for displaying secondary information alongside a page’s main content.

![Aside block examples](./assets/images/aside-examples.png)



Ibis Next offers a tailored Markdown syntax designed for presenting asides. To demarcate aside blocks, use a set of triple colons `:::` to enclose your content, specifying the type as `note`, `tip`, `caution`, or `danger`.

Three different types of quotes can be added: `quote`, `warning`, and `notice`.
While you have the flexibility to nest various other Markdown content types within an aside, it is recommended to use asides for brief and succinct portions of content.

~~~markdown
>{quote} This is a quote.
:::note
**Ibis Next** is an open-source tool, and you can contribute to the project by joining the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::

:::warning
**Ibis Next** is an open-source tool, and you can contribute to the project by joining the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::

:::tip
**Ibis Next** is an open-source tool, and you can contribute to the project by joining the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::

:::danger
**Ibis Next** is an open-source tool, and you can contribute to the project by joining the [Ibis Next GitHub repository](https://github.com/Hi-Folks/ibis-next).
:::
~~~

>{warning} This is a warning.
You can also customize the title od the aside block using the square brackets `[your title]` in this way:

>{notice} This is a notice.
~~~markdown
:::tip[My two cents]
I want to give you a piece of advice: use **Ibis Next** to create your e-books.
:::
~~~

In the example above, the aside type "tip" was used (`:::tip`), with a custom title "My two cents" (`[My two cents]`) and the content of the block can contain text formatted with classic Markdown markers.


### Using images

Images can be stored in the content folder and then brought in like this:
Images can be added into the markdown in two different way:

1. using a remote image like

~~~markdown
![Screenshot 1](content/screenshot-1.png)
![Ibis Next Cover Image](https://raw.githubusercontent.com/hi-folks/ibis-next/main/art/ibis-next-cover.png)
~~~

2. using a relative path, in this case the path is realtive to the content directory, where you have your Markdown files (the default is `./content/`)

~~~markdown
![Ibis Next Cover Image](../assets/images/ibis-next-cover.png)
~~~

It also works with absolute paths, but I don't recommend using this option as it's strongly tied to your specific machine.

### 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.
If your cover is in a PNG format you can store the file in the `assets/` directory and then in the `ibis.php` file you can adjust the `cover` configuration where you can set the cover file name, for example:
Expand Down Expand Up @@ -84,8 +123,8 @@ This is an example.

~~~

![Setting the page header](https://raw.githubusercontent.com/hi-folks/ibis-next/main/art/ibis-next-setting-page-header.png)
![Setting the page header](../assets/images/ibis-next-setting-page-header.png)

### 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`).
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`).
4 changes: 3 additions & 1 deletion stubs/content/005-generating.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,6 @@ ibis-next epub -c ../your-dir-with-markdown-files -d ../myibisbook

You can combine the usage of the `-c` option for defining the content directory and the `-d` option for defining the working directory.

>{notice} You can organize your Markdown files in your content directory in subfolders.
:::tip
You can organize your Markdown files in your content directory in subfolders.
:::

0 comments on commit 1445b49

Please sign in to comment.