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

cuervo

v0.4.0

Published

Static site generator

Downloads

13

Readme

Build Status Coverage Status Cuervo on NPM Dependency Status

Setup

I'll go ahead and jump on the bandwagon and say at this point: this is NOT a stable or finished project. It's a work in progress, and there's a good chance I'll slowly (or rapidly) develop individual pieces as I go.

If, against your own better judgment, you're still reading this, you can get this now by just typing

npm install -g cuervo

When the dependencies have been installed, you should be able to change to the directory that contains your blog files, and run...

cuervo

Along the same vein as Jekyll and Heckle, it parses a _config.yml for default options, and treats _posts, _layouts, and _includes dirs. Your templates (_includes are like partials) should be in Mustache syntax, but all your posts will also be parsed using Markdown.

Typical site format looks like this:

  • _config.yml
  • contact.mustache
  • styles
    • page.css
  • about.mustache
  • _posts
    • 2014-01-10-title.md
  • _layouts
    • page.mustache
  • _includes
    • header.mustache
    • footer.mustache
    • widget.md

This will result in the following in (_site) :

  • feed.rss
  • contact.html
  • about.html
  • .htaccess
  • title.html
  • style
    • page.css

Config options

The configs are by default determined in the main Cuervo class:

defaults : {
        postLink: "${name}.html", // mustache-formatted output url
        makeRewrites: true, // makes an .htaccess file for your main pages (about.html = /about)
        latestNewsCount: 5, // for the latestNews variable, how many posts?
        makeFeed: false, // make an rss feed?
        summaryWords: 100, // how many words to determine the summary?
        summaryReadMoreText: "... read more" // when you run out of words, what does the link say?
    }

You you should also provide the following in your _config.yml

domain: http://yourdomain.com
sitename: Your Site 
description: Your blog of stuff
feedImage: images/feedLogo.png

Why?

A fork of a clone! Heckle gave me the idea, which Marijn Haverbeke describes as a "minimal Jekyll clone in node.js."

Like Marijn, I liked the approach to managing a site taken by Jekyll.

Also like Marijn, I don't like Ruby. However, unlike Marijn, I DO enjoy logic-less templates.

So the chain goes like this:

  • Jekyll is Ruby with Liquid as the templating engine.

  • Heckle is JavaScript with Mold (programmable template extravaganza) as the templating engine.

And NOW:

  • Cuervo is JavaScript with Mustache as the templating engine.

Cuervo? Are you drunk?

At the time of writing... maybe.

But cuervo is the spanish word for Crow. Follow my logic here: Jekyll was named after the mad scientist from Dr. Jekyll and Mr. Hyde. Heckle was transferring that logic to the magpies from the old Terry Toons animations. I'm following the common conception that they were the crows from the old Dumbo cartoon, and giving them a classy Mexican mustache. It's so removed at this point I know you don't care, but I had to name it something.