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

uncanny

v0.2.3

Published

static blog generator

Downloads

20

Readme

uncanny.js

Generate/compile static files based on file extension. Operates primarily off of config.json in the main directory as such:

{
  "source": "/home/coolguy/blog",
  "target": "/var/www/coolguysblog"
}

If they don't already exist, the following directories will be created in both source and target:

  • blogs/
  • styles/
  • scripts/
  • templates/

Whenever a file is updated in source, the corresponding file will be updated in target.


The blogs/ directory accepts:

  • 2015-10-21-blog-name.md parsed as Markdown using marked into HTML (named as .htm). The timestamp at the beginning will be used as the date of the post, if a md file is saved in the source/blogs/ directory without a timestamp, uncanny will attempt to rename it to work.

  • layout.ejs used to render every blog post into HTML, so you can make it pretty. Output will be target/blog-name.html. Available to the layout is the standard uncanny object as well as a blog object that contains:

    • year: year of the post,
    • month: month of the post,
    • day: numerical day of the post,
    • name: name of blog (with dashes),
    • title: title of the blog (generated),
    • target: location of the file,
    • content: Markdown-parsed content,
    • source: filename of original blog

The templates/ directory accepts:

  • .ejs parsed as ejs using ejs' official node module. Each template is passed the uncanny object containing:

    • version: current running version of uncanny
    • scripts, styles, templates: arrays of filenames from within corresponding directories.
    • blogs: array of blog objects as described above

The scripts/ directory accepts:

  • File extensions appended with .min such as .min.js will be run through UglifyJS before being placed in the target.

The styles/ directory accepts:

  • File extensions appended with .min such as .min.styl or .min.css will be run through Sqwish before being placed in the target.

Further configuration options include:

  • syncOnInit to compile and copy all files from the source directory into the target on startup. Default is false.
  • watchDotFile to watch and compile dotfiles.
  • customDirs an array of additional directories to watch and sync. Currently, files synced via the customDirs config option are not mutated in any way.
  • ignoreCase to allow for case-insensitive extensions, default is false.
  • optimizeImages to run smush against images in the images/ directory. Default is false
  • run with uncanny --watch to persist and watch directories.

Built on top of freud.

License

MIT