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

@next-book/cover

v1.0.2

Published

generates covers, icons and metadata based on book.json config, then updates book html files

Downloads

5

Readme

cover

no config besides standard book.json needed

might be run using ts-node

src/ts-node-bin.ts ../boilerplate/_temp

or eventually as specified in package.json bin property

book config description and defaults:

{
  meta: {
    title: string, // defaults to  "No Title",
    author: string // defaults to "No Author",
  },
  coverGenerationOptions?: {
    disableImageGeneration: false, // the app does nothing when set to true
    disableCoverGeneration: false, // skips cover generation, and disables color detection in icon generation  
    covers: [ // list of allowed cover names, default is below 
      "amazon", // recommended amazon e-book size
      "facebook", // open graph - also generates related meta tags
      "twitter", // tweet image - also generates related meta tags
      "mkp" // standard mkp size
    ],
    disableIconsGeneration: false, // completely skips any icon generation, leaving only covers
    disableIconColorDetection: false, // forces using book css to generate icon when themeColor not set 
    sourceIcon?: string, // path to icon, might be png, svg...
    themeColor?: string, // when set, used as icon background 
    name?: string, // app name used in meta and manifest, defaults to book meta title
    shortName?: string, // similar
    description?: string, // similar 
    icons: { // supported platforms dict, allows specifying icon generation sizes and ratios by providing more comprehensive objects
      android: true,
      appleIcon: true,
      appleStartup: false,
      favicons: true,
      windows: false,
      yandex: false
    },
    assetDir: string, // allows to specify asset directory name, default to "assets" 
    disableOgMetaGeneration: false, // disables generating facebook og meta tags
    disableTwitterMetaGeneration: false, // disables generating tw meta tags
    disableManifestGeneration: false, // disables web app manifest file and meta generation 
    disableBrowserConfigGeneration: true, // disables browserconfig.xml file and meta generation
    startUrl?: string // web app startup url, default to '/'
 }
}