1.0.0

EIGHTFINITE · Aug 11, 2024 · e554c3a · e554c3a
1 parent cccb8c6
commit e554c3a
Show file tree

Hide file tree

Showing 243 changed files with 30,042 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 The Cheerio contributors
+
+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.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,178 @@
+<h1 align="center">cheerio</h1>
+
+<h5 align="center">The fast, flexible, and elegant library for parsing and manipulating HTML and XML.</h5>
+
+<div align="center">
+  <a href="https://github.com/cheeriojs/cheerio/actions/workflows/ci.yml">
+    <img src="https://github.com/cheeriojs/cheerio/actions/workflows/ci.yml/badge.svg" alt="Build Status">
+  </a>
+  <a href="https://coveralls.io/github/cheeriojs/cheerio">
+    <img src="https://img.shields.io/coveralls/github/cheeriojs/cheerio/main" alt="Coverage">
+  </a>
+  <a href="#backers">
+    <img src="https://img.shields.io/opencollective/backers/cheerio" alt="OpenCollective backers">
+  </a>
+  <a href="#sponsors">
+    <img src="https://img.shields.io/opencollective/sponsors/cheerio" alt="OpenCollective sponsors">
+  </a>
+</div>
+
+<br>
+
+[中文文档 (Chinese Readme)](https://github.com/cheeriojs/cheerio/wiki/Chinese-README)
+
+```js
+import * as cheerio from 'cheerio';
+const $ = cheerio.load('<h2 class="title">Hello world</h2>');
+
+$('h2.title').text('Hello there!');
+$('h2').addClass('welcome');
+
+$.html();
+//=> <html><head></head><body><h2 class="title welcome">Hello there!</h2></body></html>
+```
+
+## Installation
+
+`npm install cheerio`
+
+## Features
+
+**&#10084; Proven syntax:** Cheerio implements a subset of core jQuery. Cheerio
+removes all the DOM inconsistencies and browser cruft from the jQuery library,
+revealing its truly gorgeous API.
+
+**&#991; Blazingly fast:** Cheerio works with a very simple, consistent DOM
+model. As a result parsing, manipulating, and rendering are incredibly
+efficient.
+
+**&#10049; Incredibly flexible:** Cheerio wraps around
+[parse5](https://github.com/inikulin/parse5) for parsing HTML and can optionally
+use the forgiving [htmlparser2](https://github.com/fb55/htmlparser2/). Cheerio
+can parse nearly any HTML or XML document. Cheerio works in both browser and
+server environments.
+
+## API
+
+### Loading
+
+First you need to load in the HTML. This step in jQuery is implicit, since
+jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the
+HTML document.
+
+```js
+// ESM or TypeScript:
+import * as cheerio from 'cheerio';
+
+// In other environments:
+const cheerio = require('cheerio');
+
+const $ = cheerio.load('<ul id="fruits">...</ul>');
+
+$.html();
+//=> <html><head></head><body><ul id="fruits">...</ul></body></html>
+```
+
+### Selectors
+
+Once you've loaded the HTML, you can use jQuery-style selectors to find elements
+within the document.
+
+#### \$( selector, [context], [root] )
+
+`selector` searches within the `context` scope which searches within the `root`
+scope. `selector` and `context` can be a string expression, DOM Element, array
+of DOM elements, or cheerio object. `root`, if provided, is typically the HTML
+document string.
+
+This selector method is the starting point for traversing and manipulating the
+document. Like in jQuery, it's the primary method for selecting elements in the
+document.
+
+```js
+$('.apple', '#fruits').text();
+//=> Apple
+
+$('ul .pear').attr('class');
+//=> pear
+
+$('li[class=orange]').html();
+//=> Orange
+```
+
+### Rendering
+
+When you're ready to render the document, you can call the `html` method on the
+"root" selection:
+
+```js
+$.root().html();
+//=>  <html>
+//      <head></head>
+//      <body>
+//        <ul id="fruits">
+//          <li class="apple">Apple</li>
+//          <li class="orange">Orange</li>
+//          <li class="pear">Pear</li>
+//        </ul>
+//      </body>
+//    </html>
+```
+
+If you want to render the
+[`outerHTML`](https://developer.mozilla.org/en-US/docs/Web/API/Element/outerHTML)
+of a selection, you can use the `outerHTML` prop:
+
+```js
+$('.pear').prop('outerHTML');
+//=> <li class="pear">Pear</li>
+```
+
+You may also render the text content of a Cheerio object using the `text`
+method:
+
+```js
+const $ = cheerio.load('This is <em>content</em>.');
+$('body').text();
+//=> This is content.
+```
+
+### The "DOM Node" object
+
+Cheerio collections are made up of objects that bear some resemblance to
+[browser-based DOM nodes](https://developer.mozilla.org/en-US/docs/Web/API/Node).
+You can expect them to define the following properties:
+
+- `tagName`
+- `parentNode`
+- `previousSibling`
+- `nextSibling`
+- `nodeValue`
+- `firstChild`
+- `childNodes`
+- `lastChild`
+
+## Screencasts
+
+[https://vimeo.com/31950192](https://vimeo.com/31950192)
+
+> This video tutorial is a follow-up to Nettut's "How to Scrape Web Pages with
+> Node.js and jQuery", using cheerio instead of JSDOM + jQuery. This video shows
+> how easy it is to use cheerio and how much faster cheerio is than JSDOM +
+> jQuery.
+
+## Cheerio in the real world
+
+Are you using cheerio in production? Add it to the
+[wiki](https://github.com/cheeriojs/cheerio/wiki/Cheerio-in-Production)!
+
+## Sponsors
+
+Does your company use Cheerio in production? Please consider
+[sponsoring this project](https://github.com/cheeriojs/cheerio?sponsor=1)! Your
+help will allow maintainers to dedicate more time and resources to its
+development and support.
+
+## License
+
+MIT