michael/minify-html
michael
/
minify-html
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mention TS API

This commit is contained in:
Wilson Lin 2020-02-01 00:18:43 +11:00
parent 77576eee13
commit d9d8f98f71
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -23,7 +23,9 @@ Speed and effectiveness of Node.js version compared to [html-minfier](https://gi
### CLI
Precompiled binaries are available for x86-64 Windows, macOS, and Linux. To compile and install from source, run `cargo install hyperbuild`, which requires [Rust](https://www.rust-lang.org/tools/install).
Precompiled binaries are available for x86-64 Windows, macOS, and Linux.
To compile and install from source, run `cargo install hyperbuild`, which requires [Rust](https://www.rust-lang.org/tools/install).
##### Get
@ -92,6 +94,14 @@ const hyperbuild = require("hyperbuild");
const minified = hyperbuild.minify("<p> Hello, world! </p>");
```
hyperbuild is also available for TypeScript:
```ts
import * as hyperbuild from "hyperbuild";
const minified = hyperbuild.minify("<p> Hello, world! </p>");
```
</details>
<details>
@ -383,10 +393,10 @@ Spaces are removed between attributes if possible.
Entities are decoded if valid (see relevant parsing section) and their decoded characters as UTF-8 is shorter or equal in length.
Numeric entities that do not refer to a valid [Unicode Scalar Value](https://www.unicode.org/glossary/#unicode_scalar_value) are replaced with the [replacement character](https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character).
If an entity is unintentionally formed after decoding, the leading ampersand is encoded, e.g. `&&#97;&#109;&#112;;` becomes `&ampamp;`. This is done as `&amp` is equal to or shorter than all other entity representations of characters part of an entity (`[&#a-zA-Z0-9;]`), and there is no other conflicting entity name that starts with `amp`.
Right chevrons after any decoding in text are encoded to `&GT` if possible or `&GT;` otherwise.
Right chevrons after any decoding in text are encoded to `&GT` if possible or `&GT;` otherwise.
### Comments