Skip to content

Commit 5559b44

Browse files
committed
Update README formatting
1 parent 12ef200 commit 5559b44

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,7 @@ This library is being built and maintained by me, @tannerlinsley and I am always
254254
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
255255
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
256256

257+
257258
- [Installation](#installation)
258259
- [Defaults to keep in mind](#defaults-to-keep-in-mind)
259260
- [Queries](#queries)
@@ -311,7 +312,7 @@ This library is being built and maintained by me, @tannerlinsley and I am always
311312
- [`useIsFetching`](#useisfetching)
312313
- [`ReactQueryConfigProvider`](#reactqueryconfigprovider)
313314
- [`setConsole`](#setconsole)
314-
- [Contributors ✨](#contributors-)
315+
- [Contributors ✨](#contributors-)
315316

316317
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
317318

@@ -2582,7 +2583,7 @@ setConsole({
25822583
- `console: Object`
25832584
- Must implement the `log`, `warn`, and `error` methods.
25842585
2585-
## Contributors ✨
2586+
# Contributors ✨
25862587
25872588
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
25882589

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@
1818
"now-build": "yarn && cd www && yarn && yarn build",
1919
"start": "rollup -c -w",
2020
"prepare": "yarn build",
21-
"prepublishOnly": "yarn test:ci",
21+
"prepublishOnly": "yarn test:ci && yarn formatReadme",
2222
"release": "yarn publish",
2323
"releaseNext": "yarn publish --tag next",
2424
"format": "prettier {src,src/**,example/src,example/src/**}/*.{md,js,jsx,tsx} --write",
25+
"formatReadme": "yarn doctoc",
2526
"doctoc": "npx doctoc --maxlevel 2 README.md",
27+
"jump2header": "npx @strdr4605/jump2header --header 'documentation' --start 'Installation' -e 2 --silent -l 2",
2628
"postinstall": "node ./scripts/postinstall.js || exit 0",
2729
"dtslint": "dtslint types"
2830
},

0 commit comments

Comments
 (0)