EPUB Tools

These are some tools I've created to help develop EPUB files. This repo is meant to be added as a submodule for another repo; see the Usage section for more details.

See .hasrc for necessary dependencies.

Goals:

1. EPUB files pass well-established validation
2. XHTML files are consistently formatted
3. content.opf files are consistently formatted

Components:

• .tidyrc - the config file for tidy
• justfile - contains the formulae for just
  • run just --list to see available formulae
• opf-lint.fish - a script to lint the content.opf file so that it is of uniform format
  • pass the path to the config file using -c/--config, or it will use the included opf-lint-config.json
• zip_book.fish - compresses a folder into a valid .epub file

Usage

As previously mentioned, This repo is meant to be added as a submodule for another repo, like so:

# you can change "tools" to whatever you like
git submodule add https://codeberg.org/cat-dev-null/epub-tools.git tools

and then create a justfile in your repo that imports the justfile in this repo. For example:

# You MUST define this as the directory you added the submodule as
epub_tools_dir := 'tools'
import 'tools/justfile'