Skip to content

Commit 6557817

Browse files
committed
Refactor docs
1 parent aeed3ab commit 6557817

File tree

2 files changed

+16
-21
lines changed

2 files changed

+16
-21
lines changed

package.json

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,13 @@
2929
"esmangle": "^1.0.0",
3030
"hast": "0.0.2",
3131
"istanbul": "^0.4.0",
32-
"remark": "^4.0.0",
33-
"remark-comment-config": "^3.0.0",
34-
"remark-github": "^4.0.1",
35-
"remark-lint": "^3.0.0",
36-
"remark-slug": "^4.1.0",
37-
"remark-usage": "^3.0.0",
38-
"remark-validate-links": "^3.0.0",
39-
"remark-yaml-config": "^3.0.0",
32+
"remark-cli": "^2.1.0",
33+
"remark-preset-wooorm": "^1.0.0",
4034
"tape": "^4.0.0",
4135
"xo": "^0.17.0"
4236
},
4337
"scripts": {
44-
"build-md": "remark . --quiet --frail",
38+
"build-md": "remark . --quiet --frail --output",
4539
"build-bundle": "browserify index.js --bare -s hastUtilParseSelector > hast-util-parse-selector.js",
4640
"build-mangle": "esmangle hast-util-parse-selector.js > hast-util-parse-selector.min.js",
4741
"build": "npm run build-md && npm run build-bundle && npm run build-mangle",
@@ -55,5 +49,8 @@
5549
"ignores": [
5650
"hast-util-parse-selector.js"
5751
]
52+
},
53+
"remarkConfig": {
54+
"presets": "wooorm"
5855
}
5956
}

readme.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,12 @@ Parse a simple CSS selector to a HAST node.
44

55
## Installation
66

7-
[npm][npm-install]:
7+
[npm][]:
88

99
```bash
1010
npm install hast-util-parse-selector
1111
```
1212

13-
**hast-util-parse-selector** is also available as an AMD, CommonJS, and globals
14-
module, [uncompressed and compressed][releases].
15-
1613
## Usage
1714

1815
```javascript
@@ -36,12 +33,15 @@ Yields:
3633

3734
Parse a CSS `selector` to a [HAST][] [node][hast-node].
3835

39-
**selector** (`string`, optional). Can contain a tag-name (`foo`),
40-
classes (`.bar`), and an ID (`#baz`).
41-
Multiple classes are allowed. Uses the last ID if multiple IDs are
42-
found.
36+
###### `selector`
37+
38+
`string`, optional — Can contain a tag-name (`foo`), classes (`.bar`),
39+
and an ID (`#baz`). Multiple classes are allowed. Uses the last ID if
40+
multiple IDs are found.
4341

44-
**Returns**: [`Node`][hast-node] — A HAST node.
42+
###### Returns
43+
44+
[`Node`][hast-node].
4545

4646
## License
4747

@@ -57,9 +57,7 @@ found.
5757

5858
[codecov]: https://codecov.io/github/wooorm/hast-util-parse-selector
5959

60-
[npm-install]: https://docs.npmjs.com/cli/install
61-
62-
[releases]: https://github.com/wooorm/hast-util-parse-selector/releases
60+
[npm]: https://docs.npmjs.com/cli/install
6361

6462
[license]: LICENSE
6563

0 commit comments

Comments
 (0)