txt2epub

A simple command line tool to convert txt file to epub html files.

Read this in other languages: English | 简体中文

Background

I have a friend, he loves reading ebooks, especially novels, but he does not like the txt format because when a txt ebook is put into a smart phone, it does not have a nice cover. So I create this little tool to help him to transform a txt file to epub file.

Usage

Currently, this tool only supports the Chinese text transformation.

Install it globally

Install this package globally, so you can use it anywhere.

npm i txt2epub -g

Install it locally

You can use this tool in your code:

npm i txt2epub

and then import it

const { generate } = require('txt2epub');

// for es module
import { generate } from 'txt2epub';

Options

To transform a txt file into an epub file, you need to specify 6 parameters:

1. sourceFile. Required. The path to your txt file, for example, hello.txt.
2. outputDir. Required. This directory name for your output epub file, for example, output.
3. title. Required. This will be used as the title of your epub file, for example, HELLO.
4. outputName. Optional. The directory you want to save your output epub file, for example, HELLO. The default value is the same as title.
5. coverPath. Optional. This is the path to your cover image, for example, ./cover.jpg.
6. author. Optional. The author of the book, for example, Jerry.

So, when you run

txt2epub --sourceFile=hello.txt --outputDir=output --title=HELLO

You will see your epub file in ./output/HELLO.epub.