Skip to content

Commit 49b4469

Browse files
committed
feat(docs): clean readme, master now src/_README.md
1 parent d0bc589 commit 49b4469

File tree

7 files changed

+570
-16
lines changed

7 files changed

+570
-16
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Svelte Headroom is a [Svelte](https://svelte.dev) component to hide or show your
3131

3232
## Props
3333

34-
### `tolerance` number {#tolerance}
34+
### `tolerance` number
3535

3636
The number of pixels that need to be scrolled in either direction for the effect to occur. This is useful if you want the user to be able to scroll slowly and not change the header position. Default: `0`.
3737

@@ -42,7 +42,7 @@ The number of pixels that need to be scrolled in either direction for the effect
4242
</Headroom>
4343

4444
```
45-
### `offsetTop` number {#offsetTop}
45+
### `offsetTop` number
4646

4747
The number of pixels from the top of the page before the effect is allowed to occur; *controls:* `class:atTop` (useful with hideAtTop, showAtTop). Default: `2`.
4848

@@ -54,7 +54,7 @@ The number of pixels from the top of the page before the effect is allowed to oc
5454

5555
```
5656

57-
### `offsetBottom` number {#offsetBottom}
57+
### `offsetBottom` number
5858

5959
The number of pixels from bottom to be considered at the bottom; *controls* `class:atBottom` (useful with hideAtBottom, showAtBottom). Default: `2`.
6060

@@ -66,7 +66,7 @@ The number of pixels from bottom to be considered at the bottom; *controls* `cla
6666

6767
```
6868

69-
### `duration` string {#duration}
69+
### `duration` string
7070

7171
The duration of the sliding effect. The value is passed on as a [CSS Transition Duration](https://developer.mozilla.org/en-US/docs/Web/CSS/transition-duration). Default: `"300ms"`.
7272

@@ -78,7 +78,7 @@ The duration of the sliding effect. The value is passed on as a [CSS Transition
7878

7979
```
8080

81-
### `easing` string {#easing}
81+
### `easing` string
8282

8383
The timing function (easing) of the sliding effect. The value is passed on as a [CSS Transition Timing Function](https://developer.mozilla.org/en-US/docs/Web/CSS/transition-timing-function). Default: `"linear"`.
8484

@@ -90,7 +90,7 @@ The timing function (easing) of the sliding effect. The value is passed on as a
9090

9191
```
9292

93-
### `bottom` boolean {#bottom}
93+
### `bottom` boolean
9494

9595
If this is to be pinned to the bottom, like a return to top button. Default: `false`.
9696

@@ -108,7 +108,7 @@ You can play with heights and widths and different positioning; *see below for m
108108

109109
```
110110

111-
### `(show|hide)At(Top|Bottom)` boolean {#ats}
111+
### `(show|hide)At(Top|Bottom)` boolean
112112

113113
If this is to be pinned to the bottom, like a return to top button. Default: `false`.
114114

@@ -174,4 +174,4 @@ A `svelte-headroom` component emits two events: `pin` and `unpin`.
174174
</Headroom>
175175
```
176176

177-
## Happy Coding! {#happy}
177+
## Happy Coding!

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
"version": "1.0.0-beta",
44
"scripts": {
55
"dev": "vite dev",
6-
"build": "svelte-kit sync && svelte-package",
6+
"build": "npm-run-all build:*",
7+
"build:readme": "node ./src/_readmecleancp.js",
8+
"build:sveltekit": "svelte-kit sync && svelte-package",
79
"prepublishOnly": "echo 'Did you mean to publish `./package/`, instead of `./`?' && exit 1",
810
"check": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json",
911
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json --watch",
@@ -19,6 +21,7 @@
1921
"@vcarl/remark-headings": "^0.1.0",
2022
"husky": "^8.0.2",
2123
"mdsvex": "^0.10.6",
24+
"npm-run-all": "^4.1.5",
2225
"remark-heading-id": "^1.0.0",
2326
"semantic-release": "^19.0.5",
2427
"svelte": "^3.53.1",

0 commit comments

Comments
 (0)