Contents

Nokogumbo - a Nokogiri interface to the Gumbo HTML5 parser.
===========

Nokogumbo provides the ability for a Ruby program to invoke the 
[Gumbo HTML5 parser](https://github.com/google/gumbo-parser#readme)
and to access the result as a Nokogiri parsed document.

Usage:
-----

```ruby
require 'nokogumbo'
doc = Nokogiri::HTML5(string)
```

Because HTML is often fetched via the web, a convenience interface is also
provided:

```ruby
require 'nokogumbo'
doc = Nokogiri::HTML5.get(uri)
```
Notes:
-----

* The `Nokogiri::HTML5.parse` function takes a string and passes it to the
<code>gumbo_parse_with_options</code> method, using the default options.
The resulting Gumbo parse tree is the walked, producing a libxml2 parse tree.
The original Gumbo parse tree is then destroyed, and single Nokogiri Ruby
object is constructed to wrap the libxml2 parse tree.  Nokogiri only produces
Ruby objects as necessary, so all scanning is done using the underlying
libxml2 libraries.

* The `Nokogiri::HTML5.get` function takes care of following redirects,
https, and determining the character encoding of the result, based on the
rules defined in the HTML5 specification for doing so.

* Instead of uppercase element names, lowercase element names are produced.

* Instead of returning `unknown` as the element name for unknown tags, the
original tag name is returned verbatim.

* The gem itself includes a copy of the Gumbo HTML5 parser.

Installation:
============

* Execute `rake gem`

* [sudo] gem install pkg/nokogumbo*.gem

Related efforts:
============

* [ruby-gumbo](https://github.com/galdor/ruby-gumbo#readme) - a ruby binding
for the Gumbo HTML5 parser.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
nokogumbo-0.6	README.md