Skip to content

Commit 46621fd

Browse files
committed
Refactor docs
1 parent 8d37953 commit 46621fd

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

readme.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Say we have the following `example.md`:
2020
## Hello **World**!
2121
```
2222

23-
...and next to it, `example.js`:
23+
and next to it, `example.js`:
2424

2525
```javascript
2626
var inspect = require('unist-util-inspect');
@@ -79,17 +79,16 @@ Take a look at [`lib/handlers/`][handlers] for examples.
7979
* [`position`][unist-position]s are properly patched
8080
* Unknown nodes with `children` are transformed to `div` elements
8181
* Unknown nodes with `value` are transformed to `text` nodes
82-
* If `node.data.hName` is set, it’s used as the HAST element’s tag-name
83-
* If `node.data.hProperties` is set, it’s mixed into the HAST element’s
82+
* [`node.data.hName`][hname] configures the HAST element’s tag-name
83+
* [`node.data.hProperties`][hproperties] is mixed into the HAST element’s
8484
properties
85-
* If `node.data.hChildren` is set, it’s used as the element’s HAST
86-
children
85+
* [`node.data.hChildren`][hchildren] configures the HAST element’s children
8786

8887
##### Examples
8988

9089
###### `hName`
9190

92-
`node.data.hName` in MDAST sets the tag-name of an element in HAST.
91+
`node.data.hName` sets the tag-name of an element.
9392
The following [MDAST][]:
9493

9594
```js
@@ -100,7 +99,7 @@ The following [MDAST][]:
10099
}
101100
```
102101

103-
Yields, in HAST:
102+
Yields, in [HAST][]:
104103

105104
```js
106105
{
@@ -113,7 +112,7 @@ Yields, in HAST:
113112

114113
###### `hProperties`
115114

116-
`node.data.hProperties` in MDAST sets the properties of an element in HAST.
115+
`node.data.hProperties` in sets the properties of an element.
117116
The following [MDAST][]:
118117

119118
```js
@@ -126,7 +125,7 @@ The following [MDAST][]:
126125
}
127126
```
128127

129-
Yields, in HAST:
128+
Yields, in [HAST][]:
130129

131130
```js
132131
{
@@ -143,7 +142,7 @@ Yields, in HAST:
143142

144143
###### `hChildren`
145144

146-
`node.data.hChildren` in MDAST sets the children of an element in HAST.
145+
`node.data.hChildren` sets the children of an element.
147146
The following [MDAST][]:
148147

149148
```js
@@ -165,8 +164,8 @@ The following [MDAST][]:
165164
}
166165
```
167166

168-
Yields, in HAST (**note**: the `pre` and `language-js` class are added
169-
normal `mdast-util-to-hast` functionality):
167+
Yields, in [HAST][] (**note**: the `pre` and `language-js` class are normal
168+
`mdast-util-to-hast` functionality):
170169

171170
```js
172171
{
@@ -246,3 +245,9 @@ repository, organisation, or community you agree to abide by its terms.
246245
[contribute]: https://github.com/syntax-tree/mdast/blob/master/contributing.md
247246

248247
[coc]: https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
248+
249+
[hname]: #hname
250+
251+
[hproperties]: #hproperties
252+
253+
[hchildren]: #hchildren

0 commit comments

Comments
 (0)