Skip to content

Commit edf1e93

Browse files
committed
docs: add some necessary steps to getting started
resolves #8
1 parent 1ac3ee0 commit edf1e93

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/content/2.getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export default defineNuxtConfig({
3333
})
3434
```
3535

36+
Finally, either remove your `app.vue` file or replace it with a custom one (starting with [this template](/usage#advanced)).
37+
3638
You're good to go!
3739

3840
## Options

docs/content/3.usage.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ Nuxt utilities like `definePageMeta` will continue to work, but you should avoid
1313
The root component of every page should be the `<ion-page>` component.
1414
::
1515

16+
::alert
17+
If you do not have a `~/pages/index.vue` file in your project, you should add the following code to the page that you want to be displayed on your app's root page:
18+
19+
```ts [pages/home.vue]
20+
definePageMeta({
21+
alias: ['/'],
22+
})
23+
```
24+
25+
::
26+
1627
## Components
1728

1829
All Ionic Vue components should be auto-imported throughout your app. (If you find one that isn't, please open an issue.) Although your IDE should be aware of these everywhere, they are not globally registered and are only imported within the components that use them.

0 commit comments

Comments
 (0)