Skip to content

Commit 01380cd

Browse files
committed
chore: swap to vitepress and reformat code
1 parent 3ea3cfa commit 01380cd

File tree

12 files changed

+272
-167
lines changed

12 files changed

+272
-167
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ node_modules
22
npm-debug.log
33
vue-scrollto.js
44
yarn.lock
5+
docs/.vitepress/cache
6+
docs/.vitepress/dist

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nuxt/plugin.js

docs/.vitepress/config.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: 'vue-scrollto',
6+
description: 'Scrolling to elements made easy.',
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
nav: [
10+
{ text: 'Docs', link: '/docs/' },
11+
{ text: 'Examples', link: '/examples/' },
12+
{ text: 'Changelog', link: '/changelog/' },
13+
],
14+
15+
outline: 'deep',
16+
17+
editLink: {
18+
pattern:
19+
'https://github.com/rigor789/vue-scrollto/tree/master/docs/:path',
20+
},
21+
22+
socialLinks: [
23+
{ icon: 'github', link: 'https://github.com/rigor789/vue-scrollto' },
24+
],
25+
},
26+
})

docs/.vuepress/config.js

-21
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,222 +1,249 @@
1-
# [2.20.0](https://github.com/rigor789/vue-scrollto/compare/v2.19.1...v2.20.0) (2020-10-28)
1+
---
2+
outline: 2
3+
---
24

5+
# [2.20.0](https://github.com/rigor789/vue-scrollto/compare/v2.19.1...v2.20.0) (2020-10-28)
36

47
### Features
58

6-
* add lazy option to allow recalculating targets ([#388](https://github.com/rigor789/vue-scrollto/issues/388)) ([e3c70c5](https://github.com/rigor789/vue-scrollto/commit/e3c70c59531b78fdb2a1cd4fa4f257447c1aa2a9))
9+
- add lazy option to allow recalculating targets ([#388](https://github.com/rigor789/vue-scrollto/issues/388)) ([e3c70c5](https://github.com/rigor789/vue-scrollto/commit/e3c70c59531b78fdb2a1cd4fa4f257447c1aa2a9))
710

811
## [2.19.1](https://github.com/rigor789/vue-scrollto/compare/v2.19.0...v2.19.1) (2020-10-09)
912

10-
1113
### Bug Fixes
1214

13-
* allow passing 0 as duration ([#376](https://github.com/rigor789/vue-scrollto/issues/376)) ([5f69269](https://github.com/rigor789/vue-scrollto/commit/5f69269db6ff9f29d4f1509eb056efc739379cfe))
15+
- allow passing 0 as duration ([#376](https://github.com/rigor789/vue-scrollto/issues/376)) ([5f69269](https://github.com/rigor789/vue-scrollto/commit/5f69269db6ff9f29d4f1509eb056efc739379cfe))
1416

1517
# [2.19.0](https://github.com/rigor789/vue-scrollto/compare/v2.18.2...v2.19.0) (2020-10-09)
1618

17-
1819
### Features
1920

20-
* add support for Vue 3 ([#371](https://github.com/rigor789/vue-scrollto/issues/371)) ([739de11](https://github.com/rigor789/vue-scrollto/commit/739de11c96e3c163af708325b2b82fb73f37c655))
21+
- add support for Vue 3 ([#371](https://github.com/rigor789/vue-scrollto/issues/371)) ([739de11](https://github.com/rigor789/vue-scrollto/commit/739de11c96e3c163af708325b2b82fb73f37c655))
2122

2223
## [2.18.2](https://github.com/rigor789/vue-scrollto/compare/v2.18.1...v2.18.2) (2020-07-29)
2324

24-
2525
### Bug Fixes
2626

27-
* export scroller to DOM ([#329](https://github.com/rigor789/vue-scrollto/issues/329)) ([4333d1e](https://github.com/rigor789/vue-scrollto/commit/4333d1e10a06ea519244e97c334c2e821c04fc2a))
27+
- export scroller to DOM ([#329](https://github.com/rigor789/vue-scrollto/issues/329)) ([4333d1e](https://github.com/rigor789/vue-scrollto/commit/4333d1e10a06ea519244e97c334c2e821c04fc2a))
2828

2929
## [2.18.1](https://github.com/rigor789/vue-scrollto/compare/v2.18.0...v2.18.1) (2020-04-15)
3030

31-
3231
### Bug Fixes
3332

34-
* allow passing 0 as offset ([#247](https://github.com/rigor789/vue-scrollto/issues/247)) ([09ee3c4](https://github.com/rigor789/vue-scrollto/commit/09ee3c4670622ea9db60a249068ca7612975e3dc))
33+
- allow passing 0 as offset ([#247](https://github.com/rigor789/vue-scrollto/issues/247)) ([09ee3c4](https://github.com/rigor789/vue-scrollto/commit/09ee3c4670622ea9db60a249068ca7612975e3dc))
3534

3635
# [2.18.0](https://github.com/rigor789/vue-scrollto/compare/v2.17.1...v2.18.0) (2020-04-12)
3736

38-
3937
### Features
4038

41-
* ignore clicks if directive value is falsy ([#243](https://github.com/rigor789/vue-scrollto/issues/243)) ([adaac9c](https://github.com/rigor789/vue-scrollto/commit/adaac9c56492451206bbb35797dc3f4fdb4f9a53)), closes [#242](https://github.com/rigor789/vue-scrollto/issues/242)
39+
- ignore clicks if directive value is falsy ([#243](https://github.com/rigor789/vue-scrollto/issues/243)) ([adaac9c](https://github.com/rigor789/vue-scrollto/commit/adaac9c56492451206bbb35797dc3f4fdb4f9a53)), closes [#242](https://github.com/rigor789/vue-scrollto/issues/242)
4240

4341
## [2.17.1](https://github.com/rigor789/vue-scrollto/compare/v2.17.0...v2.17.1) (2019-09-17)
4442

45-
4643
### Bug Fixes
4744

48-
* improved type definitions ([#160](https://github.com/rigor789/vue-scrollto/issues/160)) ([f6a6596](https://github.com/rigor789/vue-scrollto/commit/f6a6596))
45+
- improved type definitions ([#160](https://github.com/rigor789/vue-scrollto/issues/160)) ([f6a6596](https://github.com/rigor789/vue-scrollto/commit/f6a6596))
4946

5047
# [2.17.0](https://github.com/rigor789/vue-scrollto/compare/v2.16.3...v2.17.0) (2019-09-16)
5148

52-
5349
### Features
5450

55-
* add typescript bindings ([#159](https://github.com/rigor789/vue-scrollto/issues/159)) ([1b39aaf](https://github.com/rigor789/vue-scrollto/commit/1b39aaf))
51+
- add typescript bindings ([#159](https://github.com/rigor789/vue-scrollto/issues/159)) ([1b39aaf](https://github.com/rigor789/vue-scrollto/commit/1b39aaf))
5652

5753
## [2.16.3](https://github.com/rigor789/vue-scrollto/compare/v2.16.2...v2.16.3) (2019-09-10)
5854

59-
6055
### Bug Fixes
6156

62-
* only call onDone if it's defined ([55afb50](https://github.com/rigor789/vue-scrollto/commit/55afb50))
57+
- only call onDone if it's defined ([55afb50](https://github.com/rigor789/vue-scrollto/commit/55afb50))
6358

6459
## [2.16.2](https://github.com/rigor789/vue-scrollto/compare/v2.16.1...v2.16.2) (2019-09-10)
6560

66-
6761
### Bug Fixes
6862

69-
* calculation for {force: false, offset: nonZero} ([#139](https://github.com/rigor789/vue-scrollto/issues/139)) ([f01ce23](https://github.com/rigor789/vue-scrollto/commit/f01ce23)), closes [#138](https://github.com/rigor789/vue-scrollto/issues/138)
63+
- calculation for {force: false, offset: nonZero} ([#139](https://github.com/rigor789/vue-scrollto/issues/139)) ([f01ce23](https://github.com/rigor789/vue-scrollto/commit/f01ce23)), closes [#138](https://github.com/rigor789/vue-scrollto/issues/138)
7064

7165
## [2.16.1](https://github.com/rigor789/vue-scrollto/compare/v2.16.0...v2.16.1) (2019-09-10)
7266

73-
7467
### Bug Fixes
7568

76-
* force:false to correctly check element visibility in viewport ([#150](https://github.com/rigor789/vue-scrollto/issues/150)) ([14eb022](https://github.com/rigor789/vue-scrollto/commit/14eb022))
69+
- force:false to correctly check element visibility in viewport ([#150](https://github.com/rigor789/vue-scrollto/issues/150)) ([14eb022](https://github.com/rigor789/vue-scrollto/commit/14eb022))
7770

7871
# [2.16.0](https://github.com/rigor789/vue-scrollto/compare/v2.15.1...v2.16.0) (2019-09-10)
7972

80-
8173
### Features
8274

83-
* pass additional parameters to offset callback ([#135](https://github.com/rigor789/vue-scrollto/issues/135)) ([e862213](https://github.com/rigor789/vue-scrollto/commit/e862213))
75+
- pass additional parameters to offset callback ([#135](https://github.com/rigor789/vue-scrollto/issues/135)) ([e862213](https://github.com/rigor789/vue-scrollto/commit/e862213))
8476

8577
## [2.15.1](https://github.com/rigor789/vue-scrollto/compare/v2.15.0...v2.15.1) (2019-09-10)
8678

87-
8879
### Bug Fixes
8980

90-
* onDone not being called with force: true (references [#111](https://github.com/rigor789/vue-scrollto/issues/111)) ([#129](https://github.com/rigor789/vue-scrollto/issues/129)) ([6ff03b2](https://github.com/rigor789/vue-scrollto/commit/6ff03b2))
81+
- onDone not being called with force: true (references [#111](https://github.com/rigor789/vue-scrollto/issues/111)) ([#129](https://github.com/rigor789/vue-scrollto/issues/129)) ([6ff03b2](https://github.com/rigor789/vue-scrollto/commit/6ff03b2))
9182

9283
## v2.15.0 (2019-3-18)
84+
9385
- call onDone when no scrolling is needed (#128)
9486

9587
## v2.14.0 (2019-2-27)
88+
9689
- Add nuxt module (#115)
9790

9891
## v2.13.0 (2018-9-13)
9992

10093
## v2.12.0 (2018-9-13)
94+
10195
- Add force parameter (#103)
10296
- fix SSR issue with global.window (#104)
10397

10498
## v2.11.0 (2018-3-10)
99+
105100
- Add element parameter to onStart and onDone callbacks (#79)
106101

107102
## v2.10.0 (2018-3-4)
108-
- Added onStart callback (#76)
103+
104+
- Added onStart callback (#76)
109105

110106
## v2.9.0 (2018-2-24)
107+
111108
- Export scroller factory function (#74)
112109

113110
## v2.8.0 (2017-11-15)
111+
114112
- Allow a callback in offset option (#61)
115113

116114
## v2.7.10 (2017-11-8)
115+
117116
- Fixed default value being ignored for cancelable when not explicitly set
118117

119118
## v2.7.9 (2017-10-30)
119+
120120
- Fixed scrolling in relative containers (#57)
121121

122122
## v2.7.8 (2017-9-21)
123+
123124
- Fixed passive event listeners
124125

125126
## v2.7.6 (2017-9-6)
127+
126128
- Pushed the intended change for v2.7.6
127129

128130
## v2.7.6 (2017-9-6)
131+
129132
- Fixed x and y axes being switched up.
130133

131134
## v2.7.5 (2017-8-28)
135+
132136
- Add a way to cancel scrolling programmatically (#46)
133137

134138
## v2.7.4 (2017-8-22)
139+
135140
- transform Object.assign to support IE11 (issue: #37 pr: #40)
136141

137142
## v2.7.3 (2017-8-22)
143+
138144
- Disable horizontal scroll by default (#39)
139145

140146
## v2.7.2 (2017-7-9)
147+
141148
- Added support for older browsers, by not using `.find()`. (#33)
142149

143150
## v2.7.1 (2017-7-8)
151+
144152
- Fixed setting `cancelable` to false being ignored
145153

146154
## v2.7.0 (2017-6-22)
147-
- Added horizontal scroll support (#31)
155+
156+
- Added horizontal scroll support (#31)
148157

149158
## v2.6.10 (2017-6-21)
150-
- Made cancel events listener passive
159+
160+
- Made cancel events listener passive
151161

152162
## v2.6.9 (2017-6-18)
163+
153164
- Added cancelable option
154165

155166
## v2.6.8 (2017-5-6)
167+
156168
- Added default options setting.
157169
- Fixed documentation,
158170

159171
## v2.6.7 (2017-4-18)
172+
160173
- Added SSR support.
161174

162175
## v2.6.6 (2017-4-11)
176+
163177
- Updated documentation for programmatic usage and easings.
164178

165179
## v2.6.5 (2017-4-8)
180+
166181
- Added warnings when scrolling to elements that don't exist.
167182

168183
## v2.6.4 (2017-3-22)
184+
169185
- Fixed #15 - elements would share their bindings
170186

171187
## v2.6.3 (2017-3-20)
188+
172189
- Added update to directive declaration, so options can be changed dynamically.
173190

174191
## v2.6.2 (2017-3-18)
192+
175193
- Pushed updated docs to npm
176194

177195
## [v2.6.1](https://github.com/rigor789/vue-scrollto/commit/8b97dac5349546bef24e836787653a6124509a83) (2017-3-18)
178196

179197
### Fixes
198+
180199
- Removed accidental `console.log`
181200

182201
## [v2.6.0](https://github.com/rigor789/vue-scrollto/commit/c68fdd2632680fd78876047ea087ca7cbe9ae3c5) (2017-3-18)
183202

184203
### Changes
204+
185205
- Cleaned up repository
186206
- Added rollup
187207
- Added better docs
188208

189209
## [v2.5.4](https://github.com/rigor789/vue-scrollto/commit/919eb807bae8bf6eb201462d4f9923f7bc6c56b5) (2017-3-15)
190210

191211
### Bug fixes
212+
192213
- Fixed jumping to the top of the page in firefox when scrolling on the `body` tag. [6f5615e](https://github.com/rigor789/vue-scrollto/commit/6f5615ebe8602bf766e1401d33c6b1c24a961db2)
193-
214+
194215
## [v2.5.3](https://github.com/rigor789/vue-scrollto/commit/1b6ee1380401545897f7403a720d75d97665c219) (2017-3-14)
195216

196217
### Additions
218+
197219
- Added calculations for scrolling inside positioned elements. [7f730e8](https://github.com/rigor789/vue-scrollto/commit/7f730e82cbe0d585aa7ebd783eaf9761bc4add28)
198-
220+
199221
## [v2.5.2](https://github.com/rigor789/vue-scrollto/commit/d5aaf39b5c3584f40b298d1279d2a94a4dd9c940) (2017-3-14)
200222

201223
### Bug fixes
224+
202225
- Fixed firefox not scrolling on `body` tag. [575d90a](https://github.com/rigor789/vue-scrollto/commit/575d90ab3d60ae6fec9027fea1f72a3ffacd440b)
203226

204227
## [v2.5.1](https://github.com/rigor789/vue-scrollto/commit/e0970507d51529583e237aa4c69dcede4896af73) (2017-3-14)
205228

206229
### Additions
230+
207231
- Added examples for using the `container` option
208232

209233
## [v2.5.0](https://github.com/rigor789/vue-scrollto/commit/7abe2bb111964f173b003208c0f28eb3b6e209fd) (2017-3-14)
210234

211235
### Additions
236+
212237
- Added `container` option to allow scrolling inside different containers
213238

214239
## [v2.4.2](https://github.com/rigor789/vue-scrollto/commit/aa1cca9afc95adce564fbd976eca369aaa704917) (2017-3-6)
215240

216241
### Changes
242+
217243
- Updated the repository link in `package.json`
218244

219245
## [v2.4.1](https://github.com/rigor789/vue-scrollto/commit/bdbc6409c72ba0217348aa4cc5d9c93df9441a30) (2017-3-6)
220246

221247
### Changes
248+
222249
- Renamed package from `vue-scrollTo` to `vue-scrollto` due to npm's limited support for capital letters in package names.

0 commit comments

Comments
 (0)