README

由 Eric L. Barnes 和 Caneco 设计，来源于 Laravel News ❤️。

此 PHP 工具帮助您使用 Markdown 编写电子书。运行 ibis build，将生成包含以下内容的电子书：

封面照片。
可点击的自动生成目录。
代码语法高亮。
提供 2 种主题。浅色和深色。

Ibis 被用于创建 Laravel Queues in Action，这是一本我在 2020 年 8 月发布的电子书。点击此处获取示例：这里。

安装

请确保您的系统已安装 PHP7.3 或更高版本，并且您的 gd 扩展已在 php.ini 文件中启用。

首先，全局安装 composer 包

composer global require thedevdojo/ibis

然后，在空目录中运行此命令

ibis init

这将创建以下文件和目录

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

您可以通过编辑 /ibis.php 配置文件来配置您的书籍。

编写您的电子书

init 命令将在内容文件夹内创建示例 .md 文件。您可以通过探索这些文件来了解如何编写您的书籍。此示例内容来自 Laravel Queues in Action。

在内容目录内，您可以编写多个 .md 文件。Ibis 使用标题将书籍划分为部分和章节

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

添加不同的引用

可以添加三种不同类型的引用： quote、warning 和 notice。

>{quote} This is a quote.

>{warning} This is a warning.

>{notice} This is a notice.

使用图片

图片可以存储在内容文件夹中，然后按如下方式引入

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

添加封面图片

要使用封面图片，请在 assets/ 目录中添加一个 cover.jpg（如果您更喜欢基于 HTML 的封面页，则可以添加一个 cover.html 文件）。如果您不想使用封面图片，请删除这些文件。

使用字体

编辑您的 /ibis.php 配置文件，以定义从 /assets/fonts 目录中加载的字体文件。之后，您可以在主题中使用定义的字体（/assets/theme-light.html & /assets/theme-dark.html）。

生成 PDF 电子书

ibis build

Ibis 将按字母顺序解析文件，并将 PDF 文件存储在 /export。

默认使用浅色主题生成 PDF，要使用深色主题生成 PDF

ibis build dark

生成示例

ibis sample

ibis sample dark

此命令将使用 ibis build 命令生成的文件来生成您的 PDF 电子书的样本。您可以通过更新 /ibis.php 文件来配置要包含在样本中的页面。

开发

此项目使用 PHP CS Fixer，并定义了 .php_cs 中的代码标准。

要审查不符合标准的代码，可以运行 fix 命令作为 dry 运行。像这样运行 composer 脚本

composer run csfix-review

要修复源代码，请运行以下 composer 脚本

composer run csfix

致谢

许可证

麻省理工学院许可证（MIT）。请参阅许可证文件获取更多信息。

thedevdojo / ibis

维护者

详细信息