Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser with XPath and CSS selector support.
Java Ruby C HTML Bison Shell XSLT
Branch: master
Failed to load latest commit information.
bin Allow bin/nokogiri to properly handle urls from STDIN
ext Fixes issue#1299. Adds local name check in key? method
lib Improving documentation around serializers.
patches Moving patch files out of the `ports` dir
suppressions Fixing REE suppressions file to handle the general rb_gc_wipe_stack c…
tasks Removing unused rake tasks file
test Fixes issue#1261. JRuby's sax parser problem with square brackets in …
.autotest removing execute bit. wtf
.cross_rubies Comment out 2.2.1 for now, when it is yet to be usable for cross-buil…
.editorconfig Add .editorconfig.
.gemtest opting in to .gemtest
.gitignore Moving patch files out of the `ports` dir
.travis.yml Travis will update the Slack room #nokogiri-core
CHANGELOG.ja.rdoc Updates CHANGELOGs to add issue#1299
CHANGELOG.rdoc Updates CHANGELOGs to add issue#1299
C_CODING_STYLE.rdoc astyle can be used to approximate the C coding style.
Gemfile Update hoe-debugging dep for Ruby 2.2 support.
Manifest.txt Moving patch files out of the `ports` dir
README.ja.rdoc Update README synopsis to use a less volatile site
README.rdoc Update travis badge to pay attention only to master.
ROADMAP.md Add a ROADMAP note on document-centric API calls.
Rakefile Tidy up how the ports dir gets `rake clean`ed
STANDARD_RESPONSES.md Altered wording in "not a bug" standard response.
Y_U_NO_GEMSPEC.md More tenderlove -> sparklemotion
build_all The `build_all` script should fail if rvm fails.
dependencies.yml Upgraded to libxml2 2.9.2, and removed patches that no longer require…
test_all test_all: remove jruby 1.6 and add jruby 9k

README.rdoc

Nokogiri Build Status Dependency Status

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.

XML is like violence - if it doesn’t solve your problems, you are not using enough of it.

FEATURES:

  • XPath 1.0 support for document searching

  • CSS3 selector support for document searching

  • XML/HTML builder

Nokogiri parses and searches XML/HTML very quickly, and also has correctly implemented CSS3 selector support as well as XPath 1.0 support.

INSTALLATION

If this doesn't work:

gem install nokogiri

then please, please, please start troubleshooting here:

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

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

Instead, tell us when the above instructions don't work for you and we will help you and improve the documentation.

SUPPORT:

Before filing a bug report, please read our submission guidelines at:

* http://nokogiri.org/tutorials/getting_help.html

The Nokogiri mailing list is available here:

* https://groups.google.com/group/nokogiri-talk

The bug tracker is available here:

* https://github.com/sparklemotion/nokogiri/issues

The IRC channel is #nokogiri on freenode.

SYNOPSIS:

require 'nokogiri'
require 'open-uri'

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

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

####
# Search for nodes by xpath
doc.xpath('//h2 | //h3').each do |link|
  puts link.content
end

####
# Or mix and match.
doc.search('code.sh', '//h2').each do |link|
  puts link.content
end

REQUIREMENTS:

  • ruby 1.9.3 or higher

  • in Nokogiri 1.6.0 and later libxml2 and libxslt are bundled with the gem, but if you want to use them installed on the system:

    • libxml2 >=2.6.21 with iconv support (libxml2-dev/-devel is required too)

    • libxslt, built with and supported by the given libxml2 (libxslt-dev/-devel is required too)

ENCODING:

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

WARNING

Some documents declare one particular encoding, but use a different one. So, which encoding should the parser choose?

Remember that data is just a stream of bytes. Only we 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 100% of 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')

INSTALL:

  • sudo gem install nokogiri

Binary packages

Binary packages are available for:

DEVELOPMENT:

Developing on C Ruby (MRI)

Developing Nokogiri requires racc and rexical to generate the parser and tokenizer. To start development, make sure you have `libxml2` and `libxslt` installed.

Then install core gems and bootstrap:

$ gem install hoe rake-compiler mini_portile
$ rake newb

Developing on JRuby

Currently, development with JRuby depends on CRuby being installed. With CRuby, install racc and rexical:

$ gem install racc rexical

Make sure hoe and rake compiler are installed with JRuby:

$ jgem install hoe rake-compiler

Then run rake:

$ jruby -S rake

LICENSE:

(The MIT License)

Copyright © 2008 - 2015:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.