Skip to content

Commit 5df4764

Browse files
authored
docs: restore and update documentation (#826)
1 parent 506b5a4 commit 5df4764

33 files changed

+4290
-4268
lines changed

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shamefully-hoist=true

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ dist
1010
sw.*
1111
.env
1212
.output
13+
.data

docs/app.config.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
export default defineAppConfig({
2+
ui: {
3+
colors: {
4+
primary: 'blue',
5+
neutral: 'zinc',
6+
},
7+
},
28
docus: {
39
title: 'nuxt/ionic',
410
url: 'https://ionic.nuxtjs.org/',

docs/assets/css/main.css

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
@import "tailwindcss";
2+
@import "@nuxt/ui";
3+
4+
5+
:root {
6+
--color-blue: oklch(66.85% 0.17582 260.7);
7+
--color-blue-50: oklch(100% 0 none);
8+
--color-blue-100: oklch(98.081% 0.00906 258.34);
9+
--color-blue-200: oklch(89.967% 0.0486 260.89);
10+
--color-blue-300: oklch(82.018% 0.08975 261.51);
11+
--color-blue-400: oklch(74.222% 0.13277 261.06);
12+
--color-blue-500: oklch(66.85% 0.17582 260.7);
13+
--color-blue-600: oklch(57.957% 0.23039 261.17);
14+
--color-blue-700: oklch(49.935% 0.22723 261.78);
15+
--color-blue-800: oklch(40.624% 0.18173 261.53);
16+
--color-blue-900: oklch(30.965% 0.13179 260.75);
17+
--color-blue-950: oklch(25.869% 0.105 259.91);
18+
19+
}

docs/components/Logo.vue renamed to docs/components/AppHeaderLogo.vue

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@
1111
fill-rule="evenodd"
1212
clip-rule="evenodd"
1313
d="M30.4327 9.05578L30.5633 9.36054C31.5211 11.4721 32 13.6925 32 16C32 24.8163 24.8163 32 16 32C7.18367 32 0 24.8163 0 16C0 7.18367 7.18367 0 16 0C18.5905 0 21.0503 0.609524 23.3143 1.7415L23.619 1.89388L23.3578 2.11156C22.7048 2.63401 22.2041 3.28707 21.8776 4.04898L21.7905 4.26667L21.5946 4.17959C19.8313 3.35238 17.9592 2.91701 16 2.91701C8.77279 2.91701 2.91701 8.77279 2.91701 16C2.91701 23.2272 8.77279 29.083 16 29.083C23.2272 29.083 29.083 23.2054 29.083 16C29.083 14.2803 28.7565 12.5823 28.0816 10.9932L27.9946 10.7755L28.2122 10.6884C28.9741 10.4054 29.6707 9.92653 30.215 9.31701L30.4327 9.05578ZM26.4707 9.36057C28.3102 9.36057 29.8014 7.8694 29.8014 6.02996C29.8014 4.19051 28.3102 2.69934 26.4707 2.69934C24.6313 2.69934 23.1401 4.19051 23.1401 6.02996C23.1401 7.8694 24.6313 9.36057 26.4707 9.36057ZM15.9999 8.70754C11.9727 8.70754 8.7074 11.9728 8.7074 16.0001C8.7074 20.0273 11.9727 23.2926 15.9999 23.2926C20.0271 23.2926 23.2924 20.0273 23.2924 16.0001C23.2924 11.9728 20.0271 8.70754 15.9999 8.70754Z"
14-
fill="#5291ff"
14+
fill="var(--color-blue-500)"
1515
/>
1616
</svg>
17-
nuxt/ionic
17+
<span>
18+
Nuxt <span style="color: var(--color-blue-500)">Ionic</span>
19+
</span>
1820
</div>
1921
</template>
2022

21-
<style scoped lang="ts">
22-
css({
23-
'.logo': {
24-
display: 'flex',
25-
flexDirection: 'row',
26-
alignItems: 'center',
27-
gap: '0.5rem',
28-
fontWeight: '800',
23+
<style scoped>
24+
.logo {
25+
display: flex;
26+
flex-direction: row;
27+
align-items: center;
28+
gap: 0.5rem;
29+
font-weight: 800;
2930
}
30-
})
3131
</style>

docs/content/0.index.md

Lines changed: 0 additions & 34 deletions
This file was deleted.
File renamed without changes.

docs/content/1.get-started/1.introduction.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,22 @@ navigation.icon: uil:info-circle
33
description: 'Batteries-included, zero-config needed, Ionic integration for Nuxt'
44
---
55

6-
# Introduction
7-
86
`@nuxtjs/ionic` provides a batteries-included, zero-config needed, Ionic integration for Nuxt.
97

108
Supercharge your Ionic apps with the power of Nuxt, giving you the tremendous development experience you're used to
119
when using Nuxt for web.
1210

1311
Follow the installation guide to get going immediately, or continue reading to find out more about what this module provides.
1412

15-
::alert{type="info"}
13+
::callout{color="info" icon="i-lucide-info"}
1614
Get started with our [Installation guide](/get-started/installation).
1715
::
1816

1917
## What is Ionic?
2018

2119
[The Ionic SDK](https://ionicframework.com/) is an open-source UI toolkit for building modern, cross-platform mobile apps from a single codebase. It deeply integrates with Vue for a delightful mobile dev experience.
2220

23-
::alert{type="info"}
21+
::callout{color="info" icon="i-lucide-info"}
2422
Read the [Ionic documentation for Vue](https://ionicframework.com/docs/vue/overview) to learn more about Vue development with Ionic.
2523
::
2624

@@ -37,14 +35,14 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
3735
- **Capacitor integration**: works out-of-the-box with [Capacitor](https://capacitorjs.com/) for shipping to native platforms like iOS and Android.
3836
::
3937

40-
::alert{type="info"}
38+
::callout{color="info" icon="i-lucide-info"}
4139
Read more about [our features](/overview).
4240
::
4341

4442
## Cookbook
4543

4644
Our cookbook documentation provides common use-cases with code examples to get you going as fast as possible. And if you create something useful, come back and submit a PR to have it added to our cookbook.
4745

48-
::alert{type="info"}
46+
::callout{color="info" icon="i-lucide-info"}
4947
Discover common recipes in [our cookbook](/cookbook).
5048
::

docs/content/1.get-started/2.installation.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
---
22
navigation.icon: uil:play-circle
3-
description: 'Get started with the ionic module for Nuxt'
3+
description: 'Get started quickly by installing and setting up this module with the following instructions.'
44
---
55

6-
# Installation
7-
8-
Get started quickly by installing and setting up this module with the following instructions.
9-
106
## Prerequisites
117

128
- A fresh or existing Nuxt project
@@ -16,8 +12,12 @@ Get started quickly by installing and setting up this module with the following
1612

1713
## Installation
1814

15+
::steps{level=3}
16+
17+
### Add module
18+
1919
Add `@nuxtjs/ionic` to your project's dev dependencies:
20-
```bash
20+
```bash [Terminal]
2121
npx nuxi@latest module add ionic
2222
```
2323

@@ -32,7 +32,7 @@ export default defineNuxtConfig({
3232
})
3333
```
3434

35-
::alert{type="warning"}
35+
::callout{color="warning" icon="i-lucide-alert-triangle"}
3636
If deploying to iOS or Android, be aware the app must be able to run completely client-side. We recommend setting `ssr: false` in your nuxt config. Find out more in [deploying to both web and device](/cookbook/web-and-device).
3737
::
3838

@@ -57,11 +57,13 @@ pnpm dev -o
5757
```
5858

5959
::
60-
61-
::alert{type=success icon= .font-bold}
60+
::callout{color="success" icon="i-lucide-check-circle" .font-bold}
6261
Well done! A browser window should automatically open for <http://localhost:3000>.
6362
::
6463

65-
::alert{type=info}
64+
65+
::callout{color="info" icon="i-lucide-info"}
6666
The first time you start a Nuxt project with `@nuxtjs/ionic` enabled, a `ionic.config.json` file will be created if it doesn't already exist.
6767
::
68+
69+
::

docs/content/1.get-started/3.configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2+
title: Configuration
3+
description: >
4+
This module provides configuration options for itself, as well as passing through configuration for ionic.
5+
Configuration for capacitor is set in the usual way, via capacitor.config.ts.
26
navigation.icon: uil:wrench
37
---
48

5-
# Configuration
69

7-
This module provides configuration options for itself, as well as passing through configuration for ionic.
8-
9-
Configuration for capacitor is set in the usual way, via capacitor.config.ts.
1010

1111
### Module Config
1212

@@ -97,7 +97,7 @@ export default defineNuxtConfig({
9797
})
9898
```
9999

100-
::alert{type="info"}
100+
::callout{color="info" icon="i-lucide-info"}
101101
Please see the [Ionic Config Options](https://ionicframework.com/docs/vue/config#config-options) for available keys, values
102102
and examples of how they work.
103103
::
@@ -106,6 +106,6 @@ and examples of how they work.
106106

107107
Capacitor is configured via the `capacitor.config.ts` file - this is only required if you are targeting native devices such as iOS or Android.
108108

109-
::alert{type="info"}
109+
::callout{color="info" icon="i-lucide-info"}
110110
Please see the [Capacitor Config docs](https://capacitorjs.com/docs/config) for more information.
111111
::

0 commit comments

Comments
 (0)