Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stfsy/node-html-light

HTML Parser for NodeJS providing a lightweight object oriented interface
https://github.com/stfsy/node-html-light

html-parser node-html-light nodejs server-side-rendering

Last synced: about 1 month ago
JSON representation

HTML Parser for NodeJS providing a lightweight object oriented interface

Host: GitHub
URL: https://github.com/stfsy/node-html-light
Owner: stfsy
License: mit
Created: 2016-08-03T19:50:24.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-11-01T16:45:00.000Z (about 2 months ago)
Last Synced: 2024-11-01T17:29:24.771Z (about 2 months ago)
Topics: html-parser, node-html-light, nodejs, server-side-rendering
Language: JavaScript
Homepage: https://stfsy.github.io/node-html-light
Size: 1.72 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Node HTML Light

[![Build Status](https://travis-ci.org/stfsy/node-html-light.svg)](https://travis-ci.org/stfsy/node-html-light)

[![Dependency Status](https://img.shields.io/david/stfsy/node-html-light.svg)](https://github.com/stfsy/node-html-light/blob/master/package.json)

[![DevDependency Status](https://img.shields.io/david/dev/stfsy/node-html-light.svg)](https://github.com/stfsy/node-html-light/blob/master/package.json)

[![Npm downloads](https://img.shields.io/npm/dm/node-html-light.svg)](https://www.npmjs.com/package/node-html-light)

[![Npm Version](https://img.shields.io/npm/v/node-html-light.svg)](https://www.npmjs.com/package/node-html-light)

[![Git tag](https://img.shields.io/github/tag/stfsy/node-html-light.svg)](https://github.com/stfsy/node-html-light/releases)

[![Github issues](https://img.shields.io/github/issues/stfsy/node-html-light.svg)](https://github.com/stfsy/node-html-light/issues)

[![License](https://img.shields.io/npm/l/node-html-light.svg)](https://github.com/stfsy/node-html-light/blob/master/LICENSE)

HTML Parser for NodeJS providing a lightweight object oriented interface

- [API](#api)

    - [Document](#document)

    - [Node](#node)

    - [Attributes](#attributes)

    - [Text](#text)

- [Examples](#examples)

    - [Create a document using a file](#create-a-document-using-a-file)

    - [Create a Node using a File](#create-a-node-using-a-file)

    - [Create a Node using a String](#create-a-node-using-a-string)

    - [Create a Node with raw data](#create-a-node-with-raw-data)

    - [Find a child Node of an existing Element](#find-a-child-node-of-an-existing-element)

- [License](#license)

## How can I install it?

```js

npm i node-html-light --save

```

## Who is using it?

[blauspecht.io](https://www.blauspecht.io) uses `node-html-light` to render their whole page server-side. [blauspecht.io](https://www.blauspecht.io) enables you to provide rich content to your followers, schedule tweets and threads and will add AI-powered features soon.

## How can I use it?

### Document

#### Class methods

- static **fromPath**(path) -> [Document](#document)

- static **fromString**(string) -> [Document](#document)

#### Instance methods

- **html**() -> [Node](#node)

- **head**() -> [Node](#node)

- **body**() -> [Node](#node)

- **toHtml**() -> String

### Node

#### Class methods

- static **fromPath**(path) -> [Node](#node) | Array<[Node](#node)>

- static **fromString**(string) -> [Node](#node) | Array<[Node](#node)>

- static **of**(object | name, attrs) -> [Node](#node) | Array<[Node](#node)>

#### Instance properties

- name

- type

- parent

- children

- root

- nextSibling

- previousSibling

- attributes

#### Instance methods

- **appendChild**(newChild) -> void

- **appendChildBefore**(newChild, oldChild) -> void

- **appendChildAfter**(newChild, oldChild) -> void

- **find**(element, attrs, limit) -> Array<[Node](#node)>

- **filter**(callback, limit) -> Array<[Node](#node)>

- **removeChild**(child) -> void

- **replaceChild**(newChild, oldChild) -> void

- **toHtml**() -> String

### Attributes

#### Class methods

- static **of**(object) -> Array

### Text

#### Class methods

- static **of**(string) -> [Text](#text)

## Examples

### Create a document using a file

```js

const Document = require('node-html-light').Document

const resolve = require('path').resolve

Document.fromPath(resolve('./index.html')).then((document) => {

    // head is an instance of Node

    const head = document.head()

    // body is an instance of Node

    const body = document.body()

    // find child elements

    // append child elements

    // remove child elements

    // replace child elements

    return document.toHtml()

}).then((html) => {

    // ..

})

```

### Create a Node using a File

```js

const Node = require('node-html-light').Node

const resolve = require('path').resolve

Node.fromPath(resolve('partial.html')).then((node) => {})

```

### Create a Node using a String

```js

const Node = require('node-html-light').Node

const node = Node.fromString('
')

```

### Create a Node with raw data

```js

const Node = require('node-html-light').Node

const Attributes = require('node-html-light').Attributes

const node = Node.of('meta', Attributes.of({

        'name': 'viewport',

        'theme-color': '#795548'

    })

)

```

### Find a child Node of an existing Element

```js

const Node = require('node-html-light').Node

const Attributes = require('node-html-light').Attributes

const resolve = require('path').resolve

Node.fromPath(resolve('partial.html')).then((node) => {

    const content = node.find('div', Attributes.of({

        'name': 'viewport',

        'theme-color': '#795548'

    }))

})

```

## License

This project is distributed under the MIT license.