Skip to content

Commit a42c1c8

Browse files
docs: minor consistency & stylistic improvements (#5)
1 parent 77426df commit a42c1c8

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/content/1.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
2929
- Pre-render routes
3030
- Mobile meta tags
3131
- PWA support with [`nuxt-pwa-module`](https://github.com/kevinmarrec/nuxt-pwa-module)
32-
- Works out-of-the-box with [Capacitor](https://capacitorjs.com/) to build mobile apps
32+
- Works out of the box with [Capacitor](https://capacitorjs.com/) to build mobile apps
3333
::
3434

3535
::

docs/content/2.getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pnpm install nuxt-ionic -D
2525

2626
Then add the module to your Nuxt configuration:
2727

28-
```js{}[nuxt.config.js]
28+
```js{}[nuxt.config]
2929
import { defineNuxtConfig } from 'nuxt'
3030
3131
export default defineNuxtConfig({
@@ -60,17 +60,17 @@ export default defineNuxtConfig({
6060
- **meta**
6161

6262
Default: `true`
63-
Disable to take full control of meta tags
63+
Disable to take full control of meta tags.
6464

6565
- **pwa**
6666

6767
Default: `true`
68-
Disable to take full control of icon generation, manifest and service worker installation
68+
Disable to take full control of icon generation, manifest and service worker installation.
6969

7070
- **router**
7171

7272
Default: `true`
73-
Disable to configure Ionic Router yourself
73+
Disable to configure Ionic Router yourself.
7474

7575
### `css`
7676

@@ -87,4 +87,4 @@ export default defineNuxtConfig({
8787
- **utilities**
8888

8989
Default: `false`
90-
Enable to add extra Ionic CSS utilities
90+
Enable to add extra Ionic CSS utilities.

docs/content/3.usage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: ''
55

66
## Page routing
77

8-
Out of the box, you can start building your Ionic application with by creating routes within `~/pages` directory. To access the router, you should use `useIonRouter()` rather than an import from `vue-router`.
8+
Out of the box, you can start building your Ionic application by creating routes within `~/pages` directory. To access the router, you should use `useIonRouter()` rather than an import from `vue-router`.
99

10-
Nuxt utilities like `definePageMeta` will continue to work, but you likely not try to use `<NuxtPage>` or `<NuxtLayout>`.
10+
Nuxt utilities like `definePageMeta` will continue to work, but you should avoid using `<NuxtPage>` or `<NuxtLayout>`.
1111

1212
::alert
1313
The root component of every page should be the `<ion-page>` component.
@@ -17,21 +17,21 @@ The root component of every page should be the `<ion-page>` component.
1717

1818
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.
1919

20-
For more on how component imports work, see [the Nuxt documentation](https://v3.nuxtjs.org/guide/directory-structure/components#components-directory).
20+
For more on how component imports work, see the [Nuxt documentation](https://v3.nuxtjs.org/guide/directory-structure/components#components-directory).
2121

2222
## Helper functions
2323

2424
Nuxt provides a number of Ionic hooks/composables via auto-imports within your app:
2525

2626
`createAnimation`, `createGesture`, `getPlatforms`, `getTimeGivenProgression`, `iosTransitionAnimation`, `isPlatform`, `mdTransitionAnimation`, `menuController`, `onIonViewWillEnter`, `onIonViewDidEnter`, `onIonViewWillLeave`, `onIonViewDidLeave`, `useBackButton`, `useKeyboard`, `useIonRouter`
2727

28-
For more on what these do, you can read the [Ionic docs](https://ionicframework.com/docs/). For more on how auto-imports work, see [the Nuxt documentation](https://v3.nuxtjs.org/guide/concepts/auto-imports#auto-imports).
28+
For more on what these do, you can read the [Ionic docs](https://ionicframework.com/docs/). For more on how auto-imports work, see the [Nuxt documentation](https://v3.nuxtjs.org/guide/concepts/auto-imports#auto-imports).
2929

3030
## Advanced
3131

32-
### Customising your root `app.vue`
32+
### Customizing your root `app.vue`
3333

34-
If you need to customise the default Ionic `app.vue` file, you can create a new one in your project's source directory.
34+
If you need to customize the default Ionic `app.vue` file, you can create a new one in your project's source directory.
3535

3636
This is the default:
3737

0 commit comments

Comments
 (0)