November's Paddleball Marathon
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

reliure

1.0.0 • Public • Published

Reliure

Build Status License: GPL-3.0 Liberapay Beerpay

Bind your LaTeX books for e-readers.

Screenshot of Reliure running in a terminal

Features

  • Compiles LaTeX files in epub and mobi
  • Cross-platform compatibility (Windows, Mac and Linux)
  • Configuration in a single file
  • Replaces part of the configuration for a specific format
  • Supports cover image
  • Supports metadata

ℹ️ KindleGen does not work on 64-bit MacOS. On this platform, you can only compile in epub.

Prerequisites

You need to have on your computer:

Installation

Then, you can install the Reliure tool globally in order to be able to execute it wherever you want:

npm install -g reliure@latest

Usage

Configuration file

Your entry point is a configuration file named reliure.yml:

# Name of the output file 
filename: My Ebook
 
# Default configuration applied to every format 
default:
  # Cover image of the ebook 
  coverImage: cover.jpg
  # Files used to build the ebook (works with only one file currently) 
  files:
    - my-ebook.tex
 
  # Metadata following pandoc's options https://pandoc.org/MANUAL.html#epub-metadata 
  metadata:
    language: fr-FR
 
# Overridden configuration for epub format 
epub:
  metadata:
    identifier: "urn:isbn:1234567890123"
    rights: "ISBN: 123-4-5678901-2-3"
 
# Overridden configuration for mobi format 
mobi:
  coverImage: cover-mobi.jpg
  metadata:
    identifier: "urn:isbn:1234567890145"
    rights: "ISBN: 123-4-5678901-4-5"

Commands

Usage: reliure [options]

Options:

  • --epub: specify to bound the epub format
  • --mobi: specify to bound the mobi format
  • -v, --version: print the version number
  • -h, --help: print usage information

Examples:

reliure --epub --mobi
reliure -v
reliure --version

Install

npm i reliure

DownloadsWeekly Downloads

1

Version

1.0.0

License

GPL-3.0

Unpacked Size

250 kB

Total Files

19

Last publish

Collaborators

  • avatar