UNPKG

remark-rehype-wrap

Version:

Wrap `remark` or `rehype` subtrees in a new container node

github.com/bradlc/remark-rehype-wrap

bradlc/remark-rehype-wrap

59 lines (37 loc) • 3.53 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# remark-rehype-wrap > Wrap `remark` or `rehype` subtrees in a new container node. ## Installation ``` npm install remark-rehype-wrap ``` ```js import { remark } from 'remark' import { remarkRehypeWrap } from 'remark-rehype-wrap' await remark().use(remarkRehypeWrap).process('<p>Hello, world!</p>') ``` ## Usage See [`test.js`](https://github.com/bradlc/remark-rehype-wrap/blob/main/test.js) for usage examples. ## Options ### `options.node` A new node to use as the wrapper. e.g. `{ type: 'element', tagName: 'div' }` ### `options.start` Either: - `string`: A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector create a new wrapper section. - `{ selector: string, inclusive?: boolean, exclude?: string }` | Property | Description | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `selector` | A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector create a new wrapper section. | | `inclusive` | Whether the start node should be included in the new wrapper section (`true`, default) or not (`false`). | | `exclude` | A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector will not create a new wrapper section, even if they match `selector` | ### `options.end` (optional) Either: - `string`: A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector end the current wrapper section. - `{ selector: string, inclusive?: boolean, exclude?: string }` | Property | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `selector` | A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector end the current wrapper section. | | `inclusive` | Whether the end node should be included in the current wrapper section (`true`) or not (`false`, default). | | `exclude` | A node selector passed to [`unist-util-select`](https://github.com/syntax-tree/unist-util-select). Nodes matching the selector will not end the current wrapper section, even if they match `selector` | If `end` is not defined then it is set to the same as `start`. ### `options.transform` (optional) The `transform` function is passed each new wrapper node and should return a node. See [`test.js`](https://github.com/bradlc/remark-rehype-wrap/blob/main/test.js#L76-L89) for an example.