# htmltidy2

> HTML Tidy

Latest version **1.2.0** (published 2024-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install htmltidy2
pnpm add htmltidy2
yarn add htmltidy2
bun add htmltidy2
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2024-01-24 |
| First published | 2015-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 18 |
| Dependencies | 0 |
| Unpacked size | 3.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 35 |
| Author | c0b41 |
| Maintainers | c0b41 |

## Links

- npm: https://www.npmjs.com/package/htmltidy2
- Repository: https://github.com/c0b41/htmltidy2
- Issues: https://github.com/c0b41/htmltidy2/issues
- npm.io page: https://npm.io/package/htmltidy2

## Recent versions

- 1.2.0 (latest) — 2024-01-24
- 1.1.1 — 2023-03-13
- 1.1.1-canary-3 — 2023-03-13
- 1.1.1-canary-2 — 2023-03-13
- 1.1.1-canary — 2023-03-13
- 1.1.0 — 2023-03-09
- 1.0.1 — 2023-02-03
- 1.0.0 — 2022-03-04
- 1.0.0-canary.0 — 2022-03-04
- 0.3.0 — 2018-02-14
- 0.2.1 — 2017-04-03
- 0.1.4 — 2015-04-11
- 0.1.3 — 2015-04-10
- 0.1.2 — 2015-04-02

## README

# HTML Tidy2 [![CI Status](https://github.com/c0b41/htmltidy2/actions/workflows/test.yml/badge.svg)](https://github.com/c0b41/htmltidy2/actions/workflows/test.yml)

Node Wrapper for HTML Tidy

## What is HTML Tidy?

HTML Tidy is an open source program for checking and generating clean XHTML/HTML.
It cleans up coding errors in HTML files and fixes bad formatting.
It can output files in the HTML, XHTML or XML file format.

Using HTML Tidy, developers can programatically clean up and fix poorly-written HTML pages.
Another use is to convert HTML to XHTML or XML.
These files can then be easily processed using the tools in the traditional XML chain,
such as XSL transforms.

## Installation

```sh
$ npm install htmltidy2
```

## Example

```javascript
var { tidy } = require('htmltidy2')
tidy('<table><tr><td>badly formatted html</tr>', function (err, html) {
  console.log(html)
})
```

## API

**tidy(text, [options], callback, binary)**

Clean html like text according optional configuration [tidy options](https://api.html-tidy.org/tidy/quickref_5.8.0.html).

Custom binary path with binary param.

```javascript
var opts = {
  doctype: 'html5',
  hideComments: false, //  multi word options can use a hyphen or "camel case"
  indent: true,
}
```

**createWorker([options], binary)**

Create transform stream which can receive html like data as writable stream and output cleaned html/xml as readable stream.

Custom binary path with binary param.

```javascript
var worker = tidy.createWorker(opts)
request.get('http://www.nodejs.org').pipe(worker).pipe(process.stdout)
```

##### Experimental Fork!

---

- [HTML Tidy](https://github.com/vavere/htmltidy)

---
_Source: https://npm.io/package/htmltidy2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._