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

shortcode-parser

v0.0.1

Published

A Shortcode parser

Downloads

2,887

Readme

shortcode-parser Build Status

Shortcode parser written in JavaScript.

Features

  • Supports self closing and enclosing shortcodes
  • Supports shortcode attributes
  • Automatic typecasting to JavaScript native objects
  • Clean & Linted JavaScript source
  • Unit tests included

Usage

Install:

npm install shortcode-parser

Install from git Repository:

git clone https://github.com/derdesign/shortcode-parser.git

Running tests:

make test

Require the library:

var shortcode = require('shortcode-parser');

Adding shortcodes:

shortcode.add('bold', function(buf, opts) {
  if (opts.upper) buf = buf.toUpperCase();
  return '<strong>' + buf + '</strong>';
});

Parsing shortcodes:

var str = "This is [bold upper=true]Bold Text[/bold]!!!";
var out = shortcode.parse(out);

Parsing shortcodes with context:

var str = "[markdown gfm tables breaks sanitize]## Hello World[/markdown]";
var out = shortcode.parse(str, {
  charcodes: function(buf, opts) {
    return marked(buf, opts);
  }
});

API

shortcode.add(name, callback)

Adds a handler to the shortcode name. The handler receives (str, params, data). When using an enclosing shortcode, str will contain the wrapped content (empty string if it's a self closing shortcode).

The params object contains the parameters for to the shortcode. The data object is passed by shortcode.parse() if provided.

shortcode.remove(name)

Removes a shortcode handler.

shortcode.parse(str, data, context)

Performs shortcode replacements on str. If context is specified, its methods will be used as shortcode handlers instead of the registered ones. The data parameter is optional and will be passed to all shortcode handlers.

shortcode.parseInContext(str, context, data)

Same as shortcode.parse but with the second and third parameters swapped. Added for convenience and readability.

License

shortcode-parser is MIT Licensed