-
Notifications
You must be signed in to change notification settings - Fork 255
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Documentation: improved docs for example
- Loading branch information
1 parent
46fa2ee
commit 5845358
Showing
1 changed file
with
12 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,20 @@ | ||
## Running the example | ||
|
||
From the example folder: | ||
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: | ||
|
||
- [fullPage.js Documentation for Vue](https://github.com/alvarotrigo/vue-fullpage.js?tab=readme-ov-file#vue-fullpagejs---official-vuejs-3-wrapper) | ||
- [fullPage.js Core / API Documentation](https://alvarotrigo.com/fullPage/docs/) | ||
- [fullPage.js Examples](https://alvarotrigo.com/fullPage/examples/) | ||
- [fullPage.js Extensions](https://alvarotrigo.com/fullPage/extensions/) | ||
|
||
## Serving the Example | ||
|
||
In order to run and serve the example, run the following command from this same folder `/examples/`: | ||
|
||
```sh | ||
npm i | ||
npm start | ||
# go to localhost:3000 | ||
``` | ||
|
||
Now you'll be able to access the example at: http://localhost:3000 |