File tree Expand file tree Collapse file tree 1 file changed +12
-55
lines changed Expand file tree Collapse file tree 1 file changed +12
-55
lines changed Original file line number Diff line number Diff line change 1
- <!--
2
- Get your module up and running quickly.
3
-
4
- Find and replace all on all files (CMD+SHIFT+F):
5
- - Name: My Module
6
- - Package name: my-module
7
- - Description: My new Nuxt module
8
- -->
9
-
10
- # @vueless/module-nuxt
1
+ # Vueless Nuxt Module
11
2
12
3
[ ![ npm version] [ npm-version-src ]] [ npm-version-href ]
13
4
[ ![ npm downloads] [ npm-downloads-src ]] [ npm-downloads-href ]
14
5
[ ![ License] [ license-src ]] [ license-href ]
15
6
[ ![ Nuxt] [ nuxt-src ]] [ nuxt-href ]
16
7
17
- - [ ✨   ; Release Notes] ( /CHANGELOG.md )
18
- <!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
19
- <!-- - [📖 Documentation](https://example.com) -->
20
-
21
- ## Features
22
-
23
- <!-- Highlight some of the features your module provide here -->
24
- - ⛰   ; Foo
25
- - 🚠   ; Bar
26
- - 🌲   ; Baz
27
-
28
8
## Quick Setup
29
9
30
- Install the module to your Nuxt application with one command:
10
+ 1 . Add ` @vueless/ module-nuxt ` dependency to your project
31
11
32
12
``` bash
33
- npx nuxi module add @ vueless/module-nuxt
13
+ npx nuxi@latest module add vueless
34
14
```
35
15
36
- That's it! You can now use My Module in your Nuxt app ✨
16
+ 2 . Add ` @vueless/module-nuxt ` to the ` modules ` section of ` nuxt.config.{ts,js} `
37
17
18
+ ``` js
19
+ {
20
+ modules: [
21
+ ' @vueless/module-nuxt'
22
+ ]
23
+ }
24
+ ```
38
25
39
- ## Contribution
40
-
41
- <details >
42
- <summary >Local development</summary >
43
-
44
- ``` bash
45
- # Install dependencies
46
- npm install
47
-
48
- # Generate type stubs
49
- npm run dev:prepare
50
-
51
- # Develop with the playground
52
- npm run dev
53
-
54
- # Build the playground
55
- npm run dev:build
56
-
57
- # Run ESLint
58
- npm run lint
59
-
60
- # Run Vitest
61
- npm run test
62
- npm run test:watch
63
-
64
- # Release new version
65
- npm run release
66
- ```
67
-
68
- </details >
69
-
26
+ That's it! You can now use ` @vueless/module-nuxt ` in your Nuxt app ✨
70
27
71
28
<!-- Badges -->
72
29
[ npm-version-src ] : https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
You can’t perform that action at this time.
0 commit comments