Skip to content
Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser with XPath and CSS selector support.
Java Ruby C HTML Yacc Shell XSLT
Find file
Latest commit fe57e90 Apr 28, 2016 @flavorjones flavorjones Merge pull request #1451 from ashivasubramanian/master
Made documentation better for ParseOptions
Failed to load latest commit information.
bin Fix cli tool example links Jun 5, 2015
ext Set CC as the RbConfig's one Apr 13, 2016
lib 1) Added documentation for ParseOptions class. Mar 26, 2016
patches [MRI] Update to libxml-2.9.3. Dec 17, 2015
suppressions Fixing REE suppressions file to handle the general rb_gc_wipe_stack c… Dec 19, 2012
tasks add a task to run the test suite against the installed version Feb 20, 2016
test attribute with unknown prefix should have the prefix in their name Mar 11, 2016
.autotest removing execute bit. wtf Dec 1, 2009
.cross_rubies Update to rake-compiler-dock-0.5.0 with support for Ruby-2.3 cross bu… Jan 1, 2016
.editorconfig Add .editorconfig. Oct 23, 2013
.gemtest opting in to .gemtest Feb 2, 2011
.gitignore Moving patch files out of the `ports` dir Jun 6, 2015
.travis.yml .travis.yml: not use versioned jruby Feb 17, 2016
CHANGELOG.rdoc update the changelog Mar 11, 2016
CONTRIBUTING.md 1) Added documentation for ParseOptions class. Mar 26, 2016
C_CODING_STYLE.rdoc astyle can be used to approximate the C coding style. Jun 5, 2012
Gemfile update dev dependencies Feb 17, 2016
LICENSE.txt Updated copyright notices to 2016 [ci skip] Jan 3, 2016
Manifest.txt add two new test files to Manifest.txt Dec 18, 2015
README.md Removing reference to violence. Mar 24, 2016
ROADMAP.md Update to roadmap Feb 17, 2016
Rakefile add a task to run the test suite against the installed version Feb 21, 2016
STANDARD_RESPONSES.md Altered wording in "not a bug" standard response. Apr 26, 2012
Y_U_NO_GEMSPEC.md More tenderlove -> sparklemotion Jun 21, 2012
appveyor.yml CI updates Aug 24, 2015
build_all Update build_all to reflect new build process Aug 24, 2015
dependencies.yml [MRI] Update to libxml-2.9.3. Dec 17, 2015
test_all add test coverage for libxml-ruby conflicts Feb 16, 2016

README.md

Nokogiri

Status

Travis Build Status Appveyor Build Status Code Climate Version Eye

Description

Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser. Among Nokogiri's many features is the ability to search documents via XPath or CSS3 selectors.

Features

  • XML/HTML DOM parser which handles broken HTML
  • XML/HTML SAX parser
  • XML/HTML Push parser
  • XPath 1.0 support for document searching
  • CSS3 selector support for document searching
  • XML/HTML builder
  • XSLT transformer

Nokogiri parses and searches XML/HTML using native libraries (either C or Java, depending on your Ruby), which means it's fast and standards-compliant.

Installation

If this doesn't work:

gem install nokogiri

then please start troubleshooting here:

http://www.nokogiri.org/tutorials/installing_nokogiri.html

There are currently 1,237 Stack Overflow questions about Nokogiri installation. The vast majority of them are out of date and therefore incorrect. Please do not use Stack Overflow.

Instead, tell us when the above instructions don't work for you. This allows us to both help you directly and improve the documentation.

Binary packages

Binary packages are available for some distributions.

Support

There are open-source tutorials (to which we invite contributions!) here: http://nokogiri.org/tutorials

Synopsis

Nokogiri is a large library, but here is example usage for parsing and examining a document:

#! /usr/bin/env ruby

require 'nokogiri'
require 'open-uri'

# Fetch and parse HTML document
doc = Nokogiri::HTML(open('http://www.nokogiri.org/tutorials/installing_nokogiri.html'))

puts "### Search for nodes by css"
doc.css('nav ul.menu li a', 'article h2').each do |link|
  puts link.content
end

puts "### Search for nodes by xpath"
doc.xpath('//nav//ul//li/a', '//article//h2').each do |link|
  puts link.content
end

puts "### Or mix and match."
doc.search('nav ul.menu li a', '//article//h2').each do |link|
  puts link.content
end

Requirements

  • Ruby 1.9.3 or higher, including any development packages necessary to compile native extensions.

  • In Nokogiri 1.6.0 and later libxml2 and libxslt are bundled with the gem, but if you want to use the system versions:

Encoding

Strings are always stored as UTF-8 internally. Methods that return text values will always return UTF-8 encoded strings. Methods that return a string containing markup (like to_xml, to_html and inner_html) will return a string encoded like the source document.

WARNING

Some documents declare one encoding, but actually use a different one. In these cases, which encoding should the parser choose?

Data is just a stream of bytes. Humans add meaning to that stream. Any particular set of bytes could be valid characters in multiple encodings, so detecting encoding with 100% accuracy is not possible. libxml2 does its best, but it can't be right all the time.

If you want Nokogiri to handle the document encoding properly, your best bet is to explicitly set the encoding. Here is an example of explicitly setting the encoding to EUC-JP on the parser:

  doc = Nokogiri.XML('<foo><bar /><foo>', nil, 'EUC-JP')

Development

  bundle install
  bundle exec rake

License

MIT. See the LICENSE.txt file.

Something went wrong with that request. Please try again.