Skip to content

Commit 97862ef

Browse files
committed
docs: update readme
1 parent 2325f2e commit 97862ef

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@
1111
<!-- [🏀 Online playground](https://stackblitz.com/github/nuxtify-dev/pages?file=playground%2Fapp.vue) -->
1212

1313
> [!NOTE]
14+
>
1415
> **Early Access Preview:**
1516
> This module is under active development. While it is already used to power a [handful of sites](https://nuxtify.dev/showcase) in production, expect things to change frequently. I will do my best to call out breaking changes in the [changelog](https://github.com/nuxtify-dev/pages/blob/main/CHANGELOG.md).
1617
1718
### Table of Contents
1819

1920
- ♾️ [Why Nuxtify?](#why-nuxtify)
21+
- 🧩 [Nuxtify Modules](#modules)
2022
-[Features](#features)
2123
- 🚀 [Quick Start](#quick-start)
2224
- 🔧 [Configuration](#configuration)
@@ -47,9 +49,25 @@ This means you can:
4749

4850
In short, Nuxtify helps you build faster, iterate smarter, and maintain consistency – without sacrificing control or creativity.
4951

52+
## <a name="modules">🧩 Modules</a>
53+
54+
### [Nuxtify Core](https://github.com/nuxtify-dev/core)
55+
56+
Provides the core functionality for Nuxtify, including:
57+
58+
- Default components, composables, and utilities
59+
- Global configuration and theming with [Vuetify](https://vuetifyjs.com/en/introduction/why-vuetify/)
60+
61+
### [Nuxtify Pages](https://github.com/nuxtify-dev/pages) (this module)
62+
63+
Provides single and multi-page website building blocks so you can _ship weirdly fast_.
64+
65+
- Ready to use page components, page templates, and email subscribe form
66+
- (coming soon) Robots, sitemaps, schema.org, social share images, broken links, and more powered by [Nuxt SEO](https://nuxtseo.com/)
67+
5068
## <a name="features">✨ Features</a>
5169

52-
Nuxtify builds on the amazing features of [Vue](https://vuejs.org/guide/introduction), [Nuxt](https://nuxt.com/docs/getting-started/introduction), and [Vuetify](https://vuetifyjs.com/en/introduction/why-vuetify/).
70+
Nuxtify Pages builds on the functionality in [Nuxtify Core](https://github.com/nuxtify-dev/core).
5371

5472
### 💡 Intuitive UI & UX
5573

@@ -102,12 +120,10 @@ Add the `@nuxtify/pages` module to `nuxt.config.ts` and configure it:
102120
// nuxt.config.ts
103121

104122
export default defineNuxtConfig({
105-
modules: [
106-
'@nuxtify/pages'
107-
],
123+
modules: ["@nuxtify/pages"],
108124
nuxtifyPages: {
109125
/* module specific options */
110-
}
126+
},
111127
});
112128
```
113129

@@ -138,11 +154,13 @@ If you need to override a [composable](https://nuxt.com/docs/guide/directory-str
138154
It's easy to stay up to date with the latest version of Nuxtify. Just update to the latest package using your favorite package manager.
139155

140156
**Minor and patch versions**
157+
141158
```bash
142159
npm update @nuxtify/pages --save
143160
```
144161

145162
**Major versions**
163+
146164
```bash
147165
npm install @nuxtify/pages@latest --save
148166
```
@@ -164,23 +182,23 @@ Here are a few ways you can get involved:
164182
```bash
165183
# Install dependencies
166184
npm install
167-
185+
168186
# Generate type stubs
169187
npm run dev:prepare
170-
188+
171189
# Develop with the playground
172190
npm run dev
173-
191+
174192
# Build the playground
175193
npm run dev:build
176-
194+
177195
# Run ESLint
178196
npm run lint
179-
197+
180198
# Run Vitest
181199
npm run test
182200
npm run test:watch
183-
```
201+
```
184202

185203
Learn about [authoring Nuxt modules](https://nuxt.com/docs/guide/going-further/modules).
186204

0 commit comments

Comments
 (0)