shortcode-parser 

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:

``shell
npm install shortcode-parser
`

Install from git Repository:

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

Running tests:

`shell
make test
`

Require the library:

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

Adding shortcodes:

`javascript
shortcode.add('bold', function(buf, opts) {
if (opts.upper) buf = buf.toUpperCase();
return '' + buf + '';
});
`

Parsing shortcodes:

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

Parsing shortcodes with context:

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

API

$3

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.

$3

Removes a shortcode handler.

$3

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.

$3

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

License

shortcode-parser` is MIT Licensed