Giter VIP home page Giter VIP logo

epubook's Introduction

epubook

version CI

A Node EPUB 3 generation library which supports from low-level API to high-level ebook abstraction with customizable themes.

Usage

Library

npm i epubook
import { Epubook } from 'epubook'

const ebook = await Epubook.create({
  title: 'title',
  description: 'something'
})

const cover = await ebook.cover('./assets/cover.jpg')
const main = ebook.page('chapter', { title: 'Main', content: 'Hello, World!' })

ebook.toc(cover, main)

await ebook.writeFile('./output.epub')

You can see full generation demo here.

CLI

npm i -g @epubook/cli

epubook --version

epubook --help

Resources

License

MIT License © 2023 XLor

epubook's People

Contributors

renovate[bot] avatar yjl9903 avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

yiwant

epubook's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): update pnpm to v8.15.9
  • chore(deps): update pnpm to v9
  • chore(deps): update pnpm/action-setup action to v2.4.1
  • fix(deps): update dependency defu to ^6.1.4
  • fix(deps): update dependency fflate to ^0.8.2
  • fix(deps): update dependency pathe to ^1.1.2
  • chore(deps): update dependency turbo to ^1.13.4
  • chore(deps): update dependency typescript to ^5.5.4
  • chore(deps): update robinraju/release-downloader action to v1.11
  • chore(deps): update actions/setup-java action to v4
  • chore(deps): update dependency turbo to v2
  • chore(deps): update dependency vitest to v2
  • chore(deps): update pnpm/action-setup action to v4
  • 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/ci.yml
  • actions/checkout v4
  • pnpm/action-setup v2.4.0
  • actions/setup-node v4
  • actions/setup-java v3
  • robinraju/release-downloader v1.8
.github/workflows/release.yml
  • actions/checkout v4
  • actions/setup-node v4
npm
package.json
  • @types/node ^20.10.0
  • turbo ^1.10.16
  • typescript ^5.3.2
  • unbuild ^2.0.0
  • vite ^5.0.2
  • vitest ^0.34.6
  • pnpm 8.11.0
packages/builder/package.json
  • defu ^6.1.3
  • fast-xml-parser ^4.3.2
  • fflate ^0.8.1
  • pathe ^1.1.1
  • rollup ^4.5.2
packages/cli/package.json
  • breadc ^0.9.7
packages/core/package.json
  • defu ^6.1.3
  • fast-xml-parser ^4.3.2
  • fflate ^0.8.1
  • pathe ^1.1.1
packages/epubook/package.json
packages/loader/package.json
  • pathe ^1.1.1
packages/theme-default/package.json
packages/xml/package.json
  • fast-xml-parser ^4.3.2
  • pathe ^1.1.1
  • Check this box to trigger a request for Renovate to run again on this repository

Roadmap

core

  • Generate abstract container (mimetype, META-INFO/container.xml)
  • Generate package document
  • Generate more opf meta info
  • Generate spine
  • Generate navigation document
  • Generate navigation document with class / style
  • Generate navigation document containing itself
  • Support legacy ncx toc
  • Bundle into a epub
  • Support fonts
  • File system?

builder

  • Extract builder from core to this package

Loader

  • Load the epub

theme-default

  • Page templates
  • Global styles
  • Check input encode
  • Insert images utils

epubook

  • Theme integration
  • Extend theme
  • Abstract dir structure
  • Per page style
  • Book option

cli

  • Read yaml config file
  • Parse markdown content file
  • Use theme to generate epub

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.