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

pub-generator

v4.4.0

Published

markdown/handlebars site generator - runs in node or browser

Downloads

87

Readme

pub-generator

CI

  • markdown/handlebars site generator
  • runs in node as part of pub-server, or in browser e.g. inside pub-pkg-editor

installation

pub-generator is included with pub-server and runs as part of the server.

server usage

the server instantiates a single generator as follows:

// resolve config
var opts = require('pub-resolve-opts')(opts, path.join(__dirname, 'node_modules'));

// instatiate generator
var generator = require('pub-generator')(opts);

// install plugins
u.each(opts.generatorPlugins, function(plugin) {
  require(plugin.path)(generator);
});

// read all sources and compile
generator.load(cb)

a minimal express page renderer would look like this:

app.get(function(req, res, next) {
  var page = generator.findPage(req.url);
  if (!page) return next();
  res.send(generator.renderDoc(page));
});

browser usage

pub-server can deliver the generator to clients in browserified form at /pub/_generator.js. Here is a slightly simplified version of this (jQuery) script. Options and plugins are retrieved separately for caching reasons.

$.getJSON('/pub/_opts.json')
.fail(function(jqXHR) { alert('unable to load /pub/_opts.json'); })
.done(function(respData) {

  // opts includes source.file data for all sources
  // see pub-server serve-scripts
  var opts = respData;

  // start client-side pub-generator
  var generator = window.generator = require('pub-generator')(opts);

  // get browserified generator plugins - avoid caching across directories
  $.getScript('/pub/_generator-plugins.js?_=' + encodeURIComponent(opts.basedir))
  .fail(function(jqXHR) { alert('unable to load generator plugins'); })
  .done(function(script) {

    generator.load(function(err) {
      if (err) return opts.log(err);

      // slightly ugly way to notify client (editor) that generator is ready
      if (window.onGeneratorLoaded) {
        window.onGeneratorLoaded(generator);
      }
    });
  });
});