npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

epubber

v0.1.2

Published

Epubber - simple low-level API for creating .epub files

Downloads

22

Readme

Epubber - simple low-level API for creating .epub files

NPM Version

Install

npm install epubber

Documentation

Not (yet) available. See comprehensive example below.

Example

Run it: npm run build && node examples/node.js

const fs = require("node:fs");
const p = require("node:path");
const { Epubber } = require("../dist/epubber.min");
// replace this with either `const { Epubber } = require("epubber")`
// or `import { Epubber } from "epubber"`

const fsp = fs.promises;

async function main() {
  const epubber = new Epubber({
    id: "test-book",
    title: "Test book",
    lang: "en",
    date: "2024-09-29",
    modified: "2024-09-29T14:00:00Z",
  });

  epubber.addContent({
    path: "style.css",
    mime: "text/css",
    content: "body { font-family: sans-serif; }",
  });

  epubber.addContent({
    path: "foreword.xhtml",
    mime: "application/xhtml+xml",
    content: `<?xml version="1.0" encoding="utf-8" standalone="no"?>
      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
      <html xmlns="http://www.w3.org/1999/xhtml">
        <head>
          <title>Test foreword</title>
          <link rel="stylesheet" href="style.css" />
        </head>
        <body>
          <p>Test foreword</p>
        </body>
      </html>`,
    addToSpine: true,
    guideType: "foreword",
  });

  epubber.addContent({
    path: "tome-00.xhtml",
    mime: "application/xhtml+xml",
    content: `<?xml version="1.0" encoding="utf-8" standalone="no"?>
      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
      <html xmlns="http://www.w3.org/1999/xhtml">
        <head>
          <title>Test tome</title>
          <link rel="stylesheet" href="style.css" />
        </head>
        <body>
          <p>Test tome</p>
        </body>
      </html>`,
    addToSpine: true,
    guideType: "text",
  });

  const sample = await fsp.readFile(p.join(__dirname, "sample-image.png"));
  const u8 = new Uint8Array(sample.buffer);

  epubber.addContent({
    path: "image.png",
    mime: "image/png",
    content: u8,
  });

  epubber.addContent({
    path: "chapter-00.xhtml",
    mime: "application/xhtml+xml",
    content: `<?xml version="1.0" encoding="utf-8" standalone="no"?>
      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
      <html xmlns="http://www.w3.org/1999/xhtml">
        <head>
          <title>Test chapter</title>
          <link rel="stylesheet" href="style.css" />
        </head>
        <body>
          <p>Test chapter</p>
          <img src="image.png" />
        </body>
      </html>`,
    addToSpine: true,
    guideType: "text",
  });

  epubber.addTocEntry({
    content: "foreword.xhtml",
    label: "Foreword",
  });

  const tome1 = epubber.addTocEntry({
    content: "tome-00.xhtml",
    label: "Tome 1",
  });

  epubber.addTocEntry({
    content: "chapter-00.xhtml",
    label: "Chapter 1",
    parent: tome1,
  });

  const blob = await epubber.generate();
  await fsp.writeFile("test-book.epub", Buffer.from(await blob.arrayBuffer()));
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

In Browser

See examples/browser/ for details.

Credits

Sample image from https://www.learningcontainer.com/sample-png-image-for-testing/