Skip to content

Commit

Permalink
Update dev-dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Sep 17, 2024
1 parent a64174d commit bbffd3c
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 48 deletions.
11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,17 @@
"unist-util-visit-parents": "^6.0.0"
},
"devDependencies": {
"@types/node": "^20.0.0",
"c8": "^8.0.0",
"@types/node": "^22.0.0",
"c8": "^10.0.0",
"is-hidden": "^2.0.0",
"prettier": "^3.0.0",
"rehype": "^13.0.0",
"remark-cli": "^11.0.0",
"remark-preset-wooorm": "^9.0.0",
"remark-cli": "^12.0.0",
"remark-preset-wooorm": "^10.0.0",
"to-vfile": "^8.0.0",
"type-coverage": "^2.0.0",
"typescript": "^5.0.0",
"xo": "^0.56.0"
"xo": "^0.59.0"
},
"scripts": {
"build": "tsc --build --clean && tsc --build && type-coverage",
Expand Down Expand Up @@ -85,6 +85,7 @@
"xo": {
"prettier": true,
"rules": {
"logical-assignment-operators": "off",
"unicorn/prefer-at": "off",
"unicorn/prefer-string-replace-all": "off"
}
Expand Down
86 changes: 43 additions & 43 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,33 @@

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeFormat[, options])`](#unifieduserehypeformat-options)
* [`Options`](#options)
* [Examples](#examples)
* [Example: markdown input (remark)](#example-markdown-input-remark)
* [Example: tabs and blank lines (`indent`, `blanks`)](#example-tabs-and-blank-lines-indent-blanks)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeFormat[, options])`](#unifieduserehypeformat-options)
* [`Options`](#options)
* [Examples](#examples)
* [Example: markdown input (remark)](#example-markdown-input-remark)
* [Example: tabs and blank lines (`indent`, `blanks`)](#example-tabs-and-blank-lines-indent-blanks)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)

## What is this?

This package is a [unified][] ([rehype][]) plugin to format whitespace in HTML.
In short, it works as follows:

* collapse all existing white space to either a line ending or a single space
* remove those spaces and line endings if they do not contribute to the
document
* inject needed line endings
* indent previously collapsed line endings properly
* collapse all existing white space to either a line ending or a single space
* remove those spaces and line endings if they do not contribute to the
document
* inject needed line endings
* indent previously collapsed line endings properly

**unified** is a project that transforms content with abstract syntax trees
(ASTs).
Expand Down Expand Up @@ -141,8 +141,8 @@ Format whitespace in HTML.

###### Parameters

* `options` ([`Options`][api-options], optional)
— configuration
* `options` ([`Options`][api-options], optional)
— configuration

###### Returns

Expand All @@ -154,16 +154,16 @@ Configuration (TypeScript type).

###### Fields

* `blanks` (`Array<string>`, default: `[]`)
— list of tag names to join with a blank line (default: `[]`); these tags,
when next to each other, are joined by a blank line (`\n\n`); for example,
when `['head', 'body']` is given, a blank line is added between these two
* `indent` (`number`, `string`, default: `2`)
— indentation per level (default: `2`); when number, uses that amount of
spaces; when `string`, uses that per indentation level
* `indentInitial` (`boolean`, default: `true`)
— whether to indent the first level (default: `true`); this is usually the
`<html>`, thus not indenting `head` and `body`
* `blanks` (`Array<string>`, default: `[]`)
— list of tag names to join with a blank line (default: `[]`); these tags,
when next to each other, are joined by a blank line (`\n\n`); for example,
when `['head', 'body']` is given, a blank line is added between these two
* `indent` (`number`, `string`, default: `2`)
— indentation per level (default: `2`); when number, uses that amount of
spaces; when `string`, uses that per indentation level
* `indentInitial` (`boolean`, default: `true`)
— whether to indent the first level (default: `true`); this is usually the
`<html>`, thus not indenting `head` and `body`

## Examples

Expand Down Expand Up @@ -276,16 +276,16 @@ When in doubt, use [`rehype-sanitize`][rehype-sanitize].

## Related

* [`rehype-minify`](https://github.com/rehypejs/rehype-minify)
— minify HTML
* [`rehype-document`](https://github.com/rehypejs/rehype-document)
— wrap a fragment in a document
* [`rehype-sanitize`](https://github.com/rehypejs/rehype-sanitize)
— sanitize HTML
* [`rehype-toc`](https://github.com/JS-DevTools/rehype-toc)
— add a table of contents (TOC)
* [`rehype-section`](https://github.com/agentofuser/rehype-section)
— wrap headings and their contents in sections
* [`rehype-minify`](https://github.com/rehypejs/rehype-minify)
— minify HTML
* [`rehype-document`](https://github.com/rehypejs/rehype-document)
— wrap a fragment in a document
* [`rehype-sanitize`](https://github.com/rehypejs/rehype-sanitize)
— sanitize HTML
* [`rehype-toc`](https://github.com/JS-DevTools/rehype-toc)
— add a table of contents (TOC)
* [`rehype-section`](https://github.com/agentofuser/rehype-section)
— wrap headings and their contents in sections

## Contribute

Expand Down

0 comments on commit bbffd3c

Please sign in to comment.