README.md
1# jsoup: Java HTML Parser
2
3**jsoup** is a Java library that makes it easy to work with real-world HTML and XML. It offers an easy-to-use API for URL fetching, data parsing, extraction, and manipulation using DOM API methods, CSS, and xpath selectors.
4
5**jsoup** implements the [WHATWG HTML5](https://html.spec.whatwg.org/multipage/) specification, and parses HTML to the same DOM as modern browsers.
6
7* scrape and [parse](https://jsoup.org/cookbook/input/parse-document-from-string) HTML from a URL, file, or string
8* find and [extract data](https://jsoup.org/cookbook/extracting-data/selector-syntax), using DOM traversal or CSS selectors
9* manipulate the [HTML elements](https://jsoup.org/cookbook/modifying-data/set-html), attributes, and text
10* [clean](https://jsoup.org/cookbook/cleaning-html/safelist-sanitizer) user-submitted content against a safe-list, to prevent XSS attacks
11* output tidy HTML
12
13jsoup is designed to deal with all varieties of HTML found in the wild; from pristine and validating, to invalid tag-soup; jsoup will create a sensible parse tree.
14
15See [**jsoup.org**](https://jsoup.org/) for downloads and the full [API documentation](https://jsoup.org/apidocs/).
16
17[](https://github.com/jhy/jsoup/actions?query=workflow%3ABuild)
18
19## Example
20Fetch the [Wikipedia](https://en.wikipedia.org/wiki/Main_Page) homepage, parse it to a [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction), and select the headlines from the *In the News* section into a list of [Elements](https://jsoup.org/apidocs/org/jsoup/select/Elements.html):
21
22```java
23Document doc = Jsoup.connect("https://en.wikipedia.org/").get();
24log(doc.title());
25Elements newsHeadlines = doc.select("#mp-itn b a");
26for (Element headline : newsHeadlines) {
27 log("%s\n\t%s",
28 headline.attr("title"), headline.absUrl("href"));
29}
30```
31[Online sample](https://try.jsoup.org/~LGB7rk_atM2roavV0d-czMt3J_g), [full source](https://github.com/jhy/jsoup/blob/master/src/main/java/org/jsoup/examples/Wikipedia.java).
32
33## Open source
34jsoup is an open source project distributed under the liberal [MIT license](https://jsoup.org/license). The source code is available on [GitHub](https://github.com/jhy/jsoup).
35
36## Getting started
371. [Download](https://jsoup.org/download) the latest jsoup jar (or add it to your Maven/Gradle build)
382. Read the [cookbook](https://jsoup.org/cookbook/)
393. Enjoy!
40
41### Android support
42When used in Android projects, [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) with the [NIO specification](https://developer.android.com/studio/write/java11-nio-support-table) should be enabled to support Java 8+ features.
43
44## Development and support
45If you have any questions on how to use jsoup, or have ideas for future development, please get in touch via [jsoup Discussions](https://github.com/jhy/jsoup/discussions).
46
47If you find any issues, please file a [bug](https://jsoup.org/bugs) after checking for duplicates.
48
49The [colophon](https://jsoup.org/colophon) talks about the history of and tools used to build jsoup.
50
51## Status
52jsoup is in general, stable release.
53
){kind=link}