html-decoder v1.0.2

HTML Decoder

The first HTML5 compliant HTML decoder. This decoder is implemented based on the HTML5 specification and can decode the full named character reference list based on this json.

Quick Start

Install the npm html-decoder from the npm repo.

npm install html-decoder

Server-side Use (node.js)

Decoding a string with numeric and named character reference.

/* create the html decoder */
var HTMLDecoder = require("html-decoder");
decoder = new HTMLDecoder();

var htmlString = ">&gt&gta ...";
/* html = '<<<a...'; */
var html = decoder.decode(htmlString);

Development

Build

grunt

How to test

grunt test

Maintenance

Generate from WHATWG

grunt gen

OR doing it manually

Get the latest named character reference json.

wget https://html.spec.whatwg.org/multipage/entities.json

Generate the trie.

# $REPO_HOME is the home directory of this repo.
cp entities.json $REPO_HOME/data 

# the output is saved @ src/gen/trie.js
./bin/genhtmlentities data/entities.json

Test the build again.

grunt test

Future works

License

This software is free to use under the BSD license. See the LICENSE file for license text and copyright information.