@nuxt/modules 0.6.0-daf88c → 0.6.0-db22b9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -30
- package/modules.json +8189 -2735
- package/package.json +46 -29
package/README.md
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
[](https://nuxt.com/modules)
|
|
2
2
|
|
|
3
3
|
# Nuxt Modules
|
|
4
4
|
|
|
5
5
|
[![npm version][npm-version-src]][npm-version-href]
|
|
6
|
+
[![Nuxt][nuxt-src]][nuxt-href]
|
|
6
7
|
[![Volta][volta-src]][volta-href]
|
|
7
8
|
|
|
8
|
-
> Discover Nuxt modules to
|
|
9
|
+
> Discover the Nuxt modules to add any CMS, Database, UI, Auth and integrations into your Vue application.
|
|
9
10
|
|
|
10
|
-
- 📖 [Module author guide](https://nuxt.com/docs/guide/going-further/modules)
|
|
11
11
|
- 🔗 [Modules listing](https://nuxt.com/modules)
|
|
12
|
+
- 📖 [Module author guide](https://nuxt.com/docs/guide/going-further/modules)
|
|
12
13
|
|
|
13
14
|
## Modules Database
|
|
14
15
|
|
|
@@ -17,17 +18,29 @@ Metadata of nuxt modules are maintained in [yml](https://en.wikipedia.org/wiki/Y
|
|
|
17
18
|
### Add/Update a module
|
|
18
19
|
|
|
19
20
|
```bash
|
|
20
|
-
|
|
21
|
+
pnpm sync <name> <repo>
|
|
21
22
|
```
|
|
22
23
|
|
|
23
|
-
Example: `
|
|
24
|
+
Example: `pnpm sync tailwindcss nuxt-modules/tailwindcss`
|
|
25
|
+
|
|
26
|
+
To sync with a branch different than `main`, suffix the repo with `#repo-branch`, example: `pnpm sync tailwindcss nuxt-modules/tailwindcss#dev`
|
|
24
27
|
|
|
25
|
-
|
|
28
|
+
If the module lives in a subdirectory of a monorepo, add the path after the branch, example: `pnpm sync scripts nuxt/scripts#main/packages/script`
|
|
26
29
|
|
|
27
30
|
### Contribution
|
|
28
31
|
|
|
29
|
-
|
|
30
|
-
|
|
32
|
+
To list a module, open a pull request directly. You don't need to open an issue first.
|
|
33
|
+
|
|
34
|
+
1. Fork and clone this repository, then run `pnpm install`.
|
|
35
|
+
2. Run `pnpm sync <name> <repo>` (see [Add/Update a module](#addupdate-a-module)). This creates `./modules/<name>.yml` from your repository's `package.json`.
|
|
36
|
+
3. Set `category` in the generated file to one of the values in [./lib/categories.ts](./lib/categories.ts). Optionally add an icon to [./icons](./icons) and reference it with `icon`.
|
|
37
|
+
4. Open a pull request.
|
|
38
|
+
|
|
39
|
+
The `description` should say what the module does. There's no need to mention Nuxt or Nuxt versions.
|
|
40
|
+
|
|
41
|
+
If your module mainly loads a third-party script (analytics, tag manager, chat widget, consent manager, captcha, ads or embed), check whether [Nuxt Scripts](https://scripts.nuxt.com/scripts) already supports it. If it doesn't, consider adding it to the [Nuxt Scripts registry](https://github.com/nuxt/scripts). Modules that build on Nuxt Scripts are welcome too, for example when they add more than an API for the script, or when the script isn't a fit for the registry.
|
|
42
|
+
|
|
43
|
+
If some data is outdated, please open a pull request with the fix.
|
|
31
44
|
|
|
32
45
|
### Using CDN
|
|
33
46
|
|
|
@@ -44,8 +57,8 @@ You can use the `@nuxt/modules` package by installing it in your project:
|
|
|
44
57
|
# npm
|
|
45
58
|
npm install @nuxt/modules
|
|
46
59
|
|
|
47
|
-
#
|
|
48
|
-
|
|
60
|
+
# pnpm
|
|
61
|
+
pnpm add @nuxt/modules
|
|
49
62
|
```
|
|
50
63
|
|
|
51
64
|
Then you can directly import the list of modules:
|
|
@@ -66,7 +79,7 @@ Field Name | Auto sync | Description
|
|
|
66
79
|
`description` | Yes | Short description
|
|
67
80
|
`repo` | No | GitHub repository. Format is `org/name` or `org/name#main/path`
|
|
68
81
|
`npm` | Yes | NPM package name
|
|
69
|
-
`icon` | No | Icon of module from [./
|
|
82
|
+
`icon` | No | Icon of module from [./icons](./icons) directory
|
|
70
83
|
`github` | No | GitHub URL
|
|
71
84
|
`website` | No | Website URL
|
|
72
85
|
`learn_more` | No | Link to learn more (website or relevant integration website)
|
|
@@ -74,43 +87,54 @@ Field Name | Auto sync | Description
|
|
|
74
87
|
`type` | No | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
|
|
75
88
|
`maintainers` | Yes | List of maintainers each item has `name`, `github` and `avatar`
|
|
76
89
|
`compatibility` | No | Module compatibility status. `nuxt` field specifies semver of supported nuxt version. `requires.bridge: true\|optional` can be used to specify Nuxt 2 bridge compatibility.
|
|
90
|
+
`mcp` | No | MCP Server URL
|
|
91
|
+
`providers` | No | Third-party services the module integrates with (see below)
|
|
77
92
|
|
|
93
|
+
#### Providers
|
|
78
94
|
|
|
79
|
-
|
|
95
|
+
Modules that integrate with many third-party services (image CDNs, font providers, analytics scripts...) can list them so they can be found when searching for the service:
|
|
80
96
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
97
|
+
```yaml
|
|
98
|
+
providers:
|
|
99
|
+
- name: plausibleAnalytics
|
|
100
|
+
label: Plausible Analytics
|
|
101
|
+
icon: simple-icons:plausibleanalytics
|
|
102
|
+
category: Analytics
|
|
103
|
+
docs: https://scripts.nuxt.com/scripts/plausible-analytics
|
|
85
104
|
```
|
|
86
105
|
|
|
87
|
-
|
|
106
|
+
Field Name | Required | Description
|
|
107
|
+
-----------|----------|--------------
|
|
108
|
+
`name` | Yes | Unique within the module, ideally the key used in the module options
|
|
109
|
+
`label` | Yes | Display name
|
|
110
|
+
`icon` | No | [Iconify](https://icones.js.org) icon name, `collection:icon`
|
|
111
|
+
`category` | No | Free-form grouping within the module
|
|
112
|
+
`docs` | No | Full URL to the provider docs
|
|
88
113
|
|
|
89
|
-
```bash
|
|
90
|
-
yarn build
|
|
91
|
-
```
|
|
92
114
|
|
|
93
|
-
##
|
|
94
|
-
|
|
95
|
-
- Clone repository
|
|
96
|
-
- Install website depenedencies using `npx yarn install`
|
|
115
|
+
## Maintenance
|
|
97
116
|
|
|
98
|
-
|
|
117
|
+
### Auto update all current modules
|
|
99
118
|
|
|
100
119
|
```bash
|
|
101
|
-
|
|
120
|
+
pnpm sync
|
|
102
121
|
```
|
|
103
122
|
|
|
104
|
-
|
|
123
|
+
### Generate `modules.json`
|
|
105
124
|
|
|
106
|
-
|
|
125
|
+
```bash
|
|
126
|
+
pnpm build
|
|
127
|
+
```
|
|
107
128
|
|
|
108
129
|
## License
|
|
109
130
|
|
|
110
131
|
[MIT](./LICENSE) - Made by Nuxt Team
|
|
111
132
|
|
|
112
|
-
[npm-version-src]: https://
|
|
113
|
-
[npm-version-href]: https://
|
|
133
|
+
[npm-version-src]: https://npmx.dev/api/registry/badge/version/@nuxt/modules
|
|
134
|
+
[npm-version-href]: https://npmx.dev/package/@nuxt/modules
|
|
135
|
+
|
|
136
|
+
[nuxt-src]: https://img.shields.io/badge/Nuxt%20Modules-18181B?logo=nuxt
|
|
137
|
+
[nuxt-href]: https://nuxt.com/modules
|
|
114
138
|
|
|
115
139
|
[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
|
|
116
140
|
[volta-href]: https://volta.net/nuxt/modules?utm_source=readme_nuxt_modules
|