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

erdblock

v1.0.1

Published

Erdblock is a modular personal webpage, which stays up to date automatically.

Downloads

3

Readme

Erdblock

Overview

Erdblock is a modular personal webpage. The content is presented by different plugins, which return their own express instance.

  • API
    • addPlugin(plugin, id, priority)
    • removePlugin(id)
    • setPriorityForPlugin(id, priority)
    • locals.title
    • locals.subtitle
    • locals.profileImage
    • locals.coverImage
  • Example
  • Licence

API

addPlugin(plugin, id, priority)

You can add plugins to an erdblock instance with the addPlugin(plugin) method.

attrubute | description - | - plugin | plugin object id | to identify the plugin for later manipulation priority | to oder the plugins (higher = first) | (optional)

// init object
var plugin = require("erdblock-default")()

// add plugin to erdblock
erdblock.addPlugin(plugin, "p1")

// or with priority
erdblock.addPlugin(plugin, "p1", 900)

removePlugin(id)

Remove plugin from erdblock.

attrubute | description - | - id | identifyer of the plugin

// remove plugin from erdblock
erdblock.removePlugin("p1")

setPriorityForPlugin(id, priority)

Set the priority for a added plugin.

attrubute | description - | - id | identifyer of the plugin priority | to oder the plugins (higher = first) |

// set priority for plugin
erdblock.setPriorityForPlugin("p1", 1000)

locals.title

Title of erdblock (H1)

locals.subtitle

Subtitle of erdblock (H2)

locals.profileImage

Absolute url to the profile image (round)

locals.coverImage

Absolute url to the cover image

Example

// init erdblock object
var erdblock                        = require("erdblock")()

// init express object
var express                         = require("express")
var app = express()

// setup url handler for erdblock
app.use("/", erdblock)

// configure main settings
erdblock.locals.title               = "Hello World"
erdblock.locals.subtitle            = "Subtitle"
erdblock.locals.profileImage        = __dirname + "/assets/profile.png"
erdblock.locals.coverImage          = __dirname + "/assets/cover.png"

// configure the plugins, and add them to the erdblock object
var website                         = require("erdblock-website")()
website.locals.config.title         = "Example"
website.locals.config.url           = "http://www.example.com/"
website.locals.config.description   = "Example Description"
erdblock.addPlugin(website)

// configure additional plugins

// configure port
app.listen(3000)

Look at the erdblock-default for more examples.

Licence

GNU GENERAL PUBLIC LICENSE Version 2