Skip to content

Commit 801ecd3

Browse files
committed
Refactor example
1 parent ca99c66 commit 801ecd3

File tree

3 files changed

+5
-54
lines changed

3 files changed

+5
-54
lines changed

example.js

Lines changed: 0 additions & 26 deletions
This file was deleted.

package.json

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@
5252
"prettier": "^2.0.0",
5353
"remark-cli": "^11.0.0",
5454
"remark-preset-wooorm": "^9.0.0",
55-
"remark-usage": "^10.0.0",
5655
"type-coverage": "^2.0.0",
5756
"typescript": "^5.0.0",
58-
"unified": "^10.0.0",
5957
"xo": "^0.54.0"
6058
},
6159
"scripts": {
@@ -76,13 +74,7 @@
7674
},
7775
"remarkConfig": {
7876
"plugins": [
79-
"remark-preset-wooorm",
80-
[
81-
"remark-usage",
82-
{
83-
"heading": "use"
84-
}
85-
]
77+
"remark-preset-wooorm"
8678
]
8779
},
8880
"typeCoverage": {
@@ -98,13 +90,6 @@
9890
"rules": {
9991
"no-await-in-loop": "off"
10092
}
101-
},
102-
{
103-
"files": "example.js",
104-
"rules": {
105-
"capitalized-comments": "off",
106-
"import/order": "off"
107-
}
10893
}
10994
],
11095
"prettier": true

readme.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,20 +64,10 @@ In browsers with [`esm.sh`][esmsh]:
6464

6565
## Use
6666

67-
Dependencies:
68-
69-
```javascript
70-
/**
71-
* @typedef {import('mdast').Root} Root
72-
*/
73-
67+
```js
7468
import {toc} from 'mdast-util-toc'
75-
```
76-
77-
Now running:
7869

79-
```javascript
80-
/** @type {Root} */
70+
/** @type {import('mdast').Root} */
8171
const tree = {
8272
type: 'root',
8373
children: [
@@ -89,6 +79,8 @@ const tree = {
8979
}
9080

9181
const table = toc(tree)
82+
83+
console.dir(table, {depth: 3})
9284
```
9385

9486
Yields:

0 commit comments

Comments
 (0)