Skip to content

Commit 5845358

Browse files
committed
- Documentation: improved docs for example
1 parent 46fa2ee commit 5845358

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

example/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
## Running the example
22

3-
From the example folder:
3+
This example demonstrates how to use fullPage.js with Vue.js. To learn how to use fullPage.js effectively, developers should refer to the relevant documentation:
4+
5+
- [fullPage.js Documentation for Vue](https://github.com/alvarotrigo/vue-fullpage.js?tab=readme-ov-file#vue-fullpagejs---official-vuejs-3-wrapper)
6+
- [fullPage.js Core / API Documentation](https://alvarotrigo.com/fullPage/docs/)
7+
- [fullPage.js Examples](https://alvarotrigo.com/fullPage/examples/)
8+
- [fullPage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)
9+
10+
## Serving the Example
11+
12+
In order to run and serve the example, run the following command from this same folder `/examples/`:
413

514
```sh
615
npm i
716
npm start
817
# go to localhost:3000
918
```
19+
20+
Now you'll be able to access the example at: http://localhost:3000

0 commit comments

Comments
 (0)