Download the PHP package hametuha/hamepub without Composer
On this page you can find all versions of the php package hametuha/hamepub. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hametuha/hamepub
More information about hametuha/hamepub
Files in hametuha/hamepub
Package hamepub
Short Description PHP Library to handle ePub 3.0
License MIT
Homepage https://github.com/hametuha/hamepub
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package hamepub
HamePub
HemePub's living example is hametuha. It's a WordPress site which is able to publish it's contents to ePub.
If you maintain PHP-based web apps, HamePub will help your multi-publishing.
NOTICE: HamePub means nothing sexual. I wrote like this, because it sounds meaningful in Japanese. (HamePubはePub作成のためのPHPライブラリであり、エッチな出来事が起きるパブではありません）
How to Install
Use composer.
How to Use
You can use HamePub for dynamic ePub generation, but for clarification, suppose that you have a static HTML collection like below:
Now we have CLI tool hamepub and you can run CLI command in your working directory.
Next, edit JSON file like below:
Setting Options
| Key | Required | Description |
|---|---|---|
id |
Yes | Unique identifier for the ePub (used as filename). |
title |
Yes | Book title. |
author |
Yes | Author name (string) or array of author objects. |
published |
Yes | Publication date in ISO 8601 format (e.g., 2023-01-01T23:00:00Z). |
root |
No | Directory containing HTML files. Default: ./dist/ |
target |
No | Output directory for the ePub file. Default: ./tmp |
lang |
No | Language code. Default: en |
isbn |
No | ISBN number. |
direction |
No | Reading direction (ltr, rtl, or default). Default: default |
cover |
No | Path to cover image. |
toc |
No | Table of contents title. Default: Table of Contents |
header.max_level |
No | Maximum header level to include in TOC. Default: 3 |
header.depth |
No | Header depth. Default: 2 |
hidden |
No | Array of HTML file names (without extension) to hide from spine. Default: ["toc"] |
url_base |
No | Regex pattern for URL replacement in assets. Default: #\./#u |
guides |
No | Array of guide objects with type, href, and optional title. |
properties |
No | Object mapping HTML file names to arrays of properties. |
Then, run command.
You will get ePub file my-first-ebook.epub.
Resources
Below are important resources.
- ePub 3 Overview
- Mark Code List for Relators is the definition of
authorsection.
Acknowledgement
The sample picture is credited by Public Domain Pictures and Nadi Lindsay.
License
This library is released under MIT.
All versions of hamepub with dependencies
ext-dom Version *
ext-json Version *
masterminds/html5 Version 2.*
minicli/minicli Version >=2.0