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

shortcodes

v1.0.0

Published

A simple library for creating shortcode macros to be used within content blocks

Downloads

618

Readme

Shortcodes

A simple library for creating shortcode macros to be used within content blocks

Build Status Dependency Status

Usage

npm install --save shortcodes

The example below shows a basic shortcode to embed a YouTube video. The actual embedment is done by the appropiate handler, called every time the shortcode is used.

const shortcodes = require('shortcodes');

shortcodes.add('youtube', (attrs) => {
  return `
    <div class="youtube" style="padding-top:${(100 / attrs.width * attrs.height)}%">
      <iframe src="https://www.youtube.com/embed/${attrs.youtube}" frameborder="0"></iframe>
    </div>
  `;
});

shortcodes.parse(`
  Lorem ipsum dolor sit amet, consetetur sadipscing elitr.

  (youtube: jNQXAC9IVRw width: 600 height: 400)

  Sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
`);

API

Shortcodes are written by providing a handler function. They accept parameters (= attributes) and return a result (= the shortcode output).

shortcode.add(name, callback)

Registers a shortcode handler for the shortcode name. It takes two parameters: the shortcode name (= the string used in a content block), and the callback function.

Shortcode names should be all lowercase and use all letters, but numbers and underscores work fine too. Be wary of using hyphens (dashes), you'll be better off not using them.

A single parameter is passed to the shortcode callback function (= an object containing all the extracted attributes). For example, the attributes object for the YouTube shortcode shown above would look like this.

{
  "youtube": "jNQXAC9IVRw",
  "width": "600",
  "height": "400"
}

shortcode.add(someObject)

In addition to shortcode.add(name, callback), you may add entire objects (= lists) of handlers (which is useful for extracting/importing shortcodes into/from plugins).

shortcodes.add({
  pow: (attrs) => Math.pow(parseInt(attrs.pow, 10), 2),
  sqrt: (attrs) => Math.sqrt(parseInt(attrs.sqrt, 10))
});

shortcode.parse(input)

Searches input for shortcodes, filters shortcodes through their hooks, and returns the modified content with shortcodes filtered out. If there are no (or invalid) shortcode tags defined, then the content will be returned without any filtering. This might cause issues when specific shortcodes are not available but the shortcode will still show up in the post/content.

Changelog

  • 1.0.0
    • Migrate to TypeScript
  • 0.0.1
    • Initial version

License

Copyright (c) 2020 Thomas Rasshofer
Licensed under the MIT license.

See LICENSE for more info.