epubCreator.js

📚 epubCreator

CLI tool for compiling a directory into an EPUB ebook

Version: 2.6.1

✨ Features

🏗️ Build EPUB from a structured directory
📝 Create config.txt template for book metadata
📂 Create directory structure with all necessary files
🔄 Convert Markdown (.md) to XHTML (.xhtml) and vice versa
📄 Convert DOCX (.docx) to Markdown (.md) with smart heading detection
🌍 Multilingual support (Indonesian & English)
📋 Chapter order control via optional ord.txt
🎨 Automatic cover, TOC, and metadata generation
📦 Zero-config build with sensible defaults

📦 Installation

git clone https://github.com/yourusername/epubcreator.git
cd epubcreator

or download as ZIP

Dependencies

npm install archiver@5.3.0 marked@4.0.0 turndown@7.2.4

For DOCX conversion (optional):

npm install mammoth@1.6.0

🚀 Usage

node epubcreator.js <command> [options]

Available Commands

createconfig Create config.txt template
createchapter Create a chapter .xhtml template file
createdir Create directory structure and template files
convertch Convert .md files to .xhtml (valid XHTML output)
convertch xhtml2md Convert .xhtml files to .md (reverse)
convertch docx2md Convert .docx files to .md (split by ## headings)
conv ... Alias for convertch
build Build EPUB from current directory
lang-id Switch language to Indonesian
lang-en Switch language to English (US)
--version, -v Show version
help, --help Show help message

📁 Directory Structure

./
├── config.txt              ← Book metadata (required)
├── ord.txt                 ← Chapter order list (optional)
├── Docs/                   ← Source .docx files (for docx2md)
├── Markdowns/              ← Source .md files (for convertch)
├── EPUB/
│   ├── images/
│   │   └── cover.png       ← REQUIRED
│   ├── audiovideo/         ← Optional
│   ├── bab1.xhtml          ← Chapters (any name, in EPUB/ root)
│   └── ...
└── builds/
    └── [folder-name].epub  ← Build result

📝 Configuration (config.txt)

# ============================================================
#  METADATA BUKU  —  edit nilai di bawah ini sesuai kebutuhan
# ============================================================

# Judul utama (wajib)
title: Judul Buku

# Subjudul (opsional)
subtitle: Subjudul

# Volume / jilid (opsional)
volume: Vol. 1

# Penulis / creator (wajib)
author: Nama Penulis

# Bahasa (default: en)
language: en

# Identifier unik (URN atau ISBN), kosongkan untuk otomatis
identifier: 

# Tanggal terbit (YYYY-MM-DD), kosongkan pakai hari ini
date: 

# Penerbit (opsional)
publisher: 

# Deskripsi / sinopsis (opsional)
description: Deskripsi singkat buku ini.

# Subjek / kategori, pisahkan dengan koma
subjects: Fiksi, Petualangan

# Nama seri (opsional)
series_name: 

# Nomor seri (opsional)
series_number: 

# Kontributor tambahan: nama|peran, nama|peran, ...
# Peran: aut (penulis), edt (editor), ill (ilustrator), dll.
contributors: 

# Judul tambahan (opsional), pisahkan dengan koma
extra_titles: 

# ============================================================
#  KONVERSI DOCX → MARKDOWN (opsional)
# ============================================================
# [docx-mapping]
# Jika bagian ini ada, konversi akan menggunakan ukuran font (dalam pt)
# Jika tidak ada, akan menggunakan style Word (Heading 1, Heading 2, dll.)
# heading1 = 24
# heading2 = 18
# heading3 = 14

📄 Order File (ord.txt)

Optional file to specify chapter order. Each line contains a .xhtml filename:

# Daftar urutan bab (satu baris satu .xhtml)
bab1.xhtml
bab2.xhtml
bab3.xhtml

If ord.txt doesn’t exist, chapters are sorted naturally (numeric-aware).

🔄 Conversion Details

convertch — Markdown → XHTML

Scans the Markdowns/ directory (or specified path)
Extracts ## Heading as chapter title
Converts Markdown to valid XHTML
Handles images, lists, tables, etc.

convertch xhtml2md — XHTML → Markdown

Scans the EPUB/ directory (or specified path)
Extracts <title> as chapter title
Converts XHTML back to Markdown
Excludes cover.xhtml, toc.xhtml, nav.xhtml

convertch docx2md — DOCX → Markdown

Scans the Docs/ directory (or specified path)
Converts DOCX to HTML using mammoth
Detects headings by Word styles (Heading 1, 2, 3) or font size
Splits output into multiple .md files by ## headings
Supports custom heading size mapping via [docx-mapping] in config.txt
Saves output to Markdowns/fromdocx/ (or custom output path)

🏗️ Build Process

The build command:

Reads config.txt for metadata
Collects chapters from EPUB/ (respects ord.txt if exists)
Detects cover image (cover.png in EPUB/images/)
Generates:
- volume.opf — EPUB package file
- toc.xhtml — Table of Contents
- cover.xhtml — Cover page
- META-INF/container.xml
Packages everything into builds/[folder-name].epub

🌍 Language Support

The tool supports Indonesian (id) and English (en).

First run will ask for language preference
Language is saved in .epubcreator.txt
Switch anytime with lang-id or lang-en

💡 Examples

Start a new book project

node epubcreator.js createdir

This creates:

config.txt
ord.txt
EPUB/ with images/ and audiovideo/
Markdowns/
Docs/

Create a chapter

node epubcreator.js createchapter
# Enter filename: bab1.xhtml
# Enter chapter title: Pengantar

Convert Markdown to XHTML

node epubcreator.js convertch

Convert DOCX to Markdown

node epubcreator.js convertch docx2md
# Or with custom path
node epubcreator.js conv docx2md --output ./MyMarkdowns

Build the EPUB

node epubcreator.js build
# Output: builds/[folder-name].epub

Convert XHTML back to Markdown

node epubcreator.js convertch xhtml2md
# Or using the alias
node epubcreator.js conv xhtml2md

📦 Dependencies

archiver (5.3.0) — ZIP packaging
marked (4.0.0) — Markdown parsing
turndown (7.2.4) — XHTML to Markdown conversion
mammoth (1.6.0) — DOCX to HTML conversion (optional)

📜 License

⭐ Support

If you find this tool useful, please give it a ⭐ on GitHub!

Happy EPUB-creating! 📚✨

This site is open source. Improve this page.