Skip to content

Conversation

@mphstudios
Copy link
Member

@mphstudios mphstudios commented Jan 21, 2026

Adds a quire epub command option to specify the output path

Examples:

quire epub --output the-digital-book.epub
quire epub -o the-digital-book.epub

See the updated [lib/epub documentation in this pull-request()

Added

  • EPUB engines (epub.js, Pandoc) output debug statements when --debug flag is used
  • Adds a quire epub command option to specify the output path

Usage

# Use project config default location
quire epub

# Custom absolute path (overrides project config)
quire epub --output /path/to/publication-ebook.epub

# Custom relative path (resolved from project root, overrides project config)
quire epub --output downloads/publication.epub

# Combined with other options
quire pdf --build --engine pandoc --output final-ebook.epub

Changed

  • Lib EPUB throws custom EpubGenerationError errors
  • Use lib/reporter to provide user feedback during the EPUB generation progress

Example EPUB command output

Success case:

❯ quire epub
⠋ Generating EPUB using Epub.js... (0.0s)
  Input: /path/to/project/_epub
  Output: /path/to/project/epubjs.epub
✔ EPUB saved to /path/to/project/epubjs.epub (2.3s)

Success with Pandoc:

❯ quire epub --engine pandoc
⠋ Generating EPUB using Pandoc... (0.0s)
  Input: /path/to/project/_epub
  Output: /path/to/project/pandoc.epub
✔ EPUB saved to /path/to/project/pandoc.epub (1.8s)

Custom output path:

❯ quire epub --output my-book.epub
⠋ Generating EPUB using Epub.js... (0.0s)
  Input: /path/to/project/_epub
  Output: /path/to/project/my-book.epub
✔ EPUB saved to /path/to/project/my-book.epub (2.1s)

Failure case:

❯ quire epub
⠋ Generating EPUB using Epub.js... (0.0s)
  Input: /path/to/project/_epub
  Output: /path/to/project/epubjs.epub
✖ EPUB generation failed (0.5s)

With --build flag:

❯ quire epub --build
⠋ Building site... (0.0s)
✔ Site built (45.2s)
⠋ Generating EPUB using Epub.js... (0.0s)
  Input: /path/to/project/_epub
  Output: /path/to/project/epubjs.epub
✔ EPUB saved to /path/to/project/epubjs.epub (2.3s)

@mphstudios mphstudios marked this pull request as ready for review January 21, 2026 18:54
@mphstudios mphstudios changed the title Feature: PDF command option for output path Feature: EPUB command option for output path Jan 21, 2026
@mphstudios mphstudios force-pushed the feature/epub-output-option branch from 369591c to 24f7d65 Compare January 21, 2026 18:56
@mphstudios mphstudios marked this pull request as draft January 21, 2026 19:08
@mphstudios mphstudios changed the title Feature: EPUB command option for output path Feature: EPUB command options, error handling, and testing Jan 21, 2026
@mphstudios mphstudios changed the title Feature: EPUB command options, error handling, and testing EPUB command options, error handling, and testing Jan 21, 2026
@mphstudios mphstudios marked this pull request as ready for review January 22, 2026 00:52
@mphstudios mphstudios force-pushed the feature/epub-output-option branch 2 times, most recently from fe2070e to 2df068d Compare January 22, 2026 22:06
Base automatically changed from refactor/cli-output-modes to feature/lib-reporter January 23, 2026 01:14
@mphstudios mphstudios force-pushed the feature/lib-reporter branch from 2db734f to f7a805d Compare January 23, 2026 03:02
@mphstudios mphstudios force-pushed the feature/epub-output-option branch from 2df068d to bebd8bc Compare January 23, 2026 03:17
@mphstudios mphstudios force-pushed the feature/lib-reporter branch 2 times, most recently from 52e304e to 480d484 Compare January 23, 2026 23:46
@mphstudios mphstudios force-pushed the feature/epub-output-option branch from bebd8bc to 0a50249 Compare January 24, 2026 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants