Skip to content

Commit

Permalink
Remove Root type
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Sep 13, 2023
1 parent 92b666a commit 32da2a3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 17 deletions.
1 change: 0 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @typedef {import('./lib/index.js').GetOnigurumaUrl} GetOnigurumaUrl
* @typedef {import('./lib/index.js').Grammar} Grammar
* @typedef {import('./lib/index.js').Options} Options
* @typedef {import('./lib/index.js').Root} Root
*/

export {grammars as all} from './lib/all.js'
Expand Down
19 changes: 3 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ source and JavaScript!
* [`GetOnigurumaUrl`](#getonigurumaurl)
* [`Grammar`](#grammar)
* [`Options`](#options)
* [`Root`](#root)
* [Examples](#examples)
* [Example: serializing hast as html](#example-serializing-hast-as-html)
* [Example: using `starry-night` on the client](#example-using-starry-night-on-the-client)
Expand Down Expand Up @@ -298,7 +297,7 @@ Highlight programming code.

###### Returns

Node representing highlighted code ([`Root`][root]).
Node representing highlighted code ([`Root`][hast-root]).

###### Example

Expand Down Expand Up @@ -497,16 +496,6 @@ Configuration (TypeScript type).
optional)
— get a URL to the oniguruma WASM, typically used in Node.js

### `Root`

Root node (TypeScript type).

###### type

```ts
export type {Root} from 'hast'
```

## Examples

### Example: serializing hast as html
Expand Down Expand Up @@ -1637,7 +1626,7 @@ Changes should go to upstream repos and [`languages.yml`][languages-yml] in

This package is fully typed with [TypeScript][].
It exports the additional types [`GetOnigurumaUrl`][api-get-oniguruma-url],
[`Grammar`][api-grammar], [`Options`][api-options], and [`Root`][api-root].
[`Grammar`][api-grammar], and [`Options`][api-options].

## Compatibility

Expand Down Expand Up @@ -1723,7 +1712,7 @@ All other files [MIT][license] © [Titus Wormer][author]

[hast]: https://github.com/syntax-tree/hast

[root]: https://github.com/syntax-tree/hast#root
[hast-root]: https://github.com/syntax-tree/hast#root

[hast-util-to-html]: https://github.com/syntax-tree/hast-util-to-html

Expand Down Expand Up @@ -1768,5 +1757,3 @@ All other files [MIT][license] © [Titus Wormer][author]
[api-grammar]: #grammar

[api-options]: #options

[api-root]: #root

0 comments on commit 32da2a3

Please sign in to comment.