@nuxt/modules 0.6.0-71d44e → 0.6.0-729986

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.
Files changed (3) hide show
  1. package/README.md +42 -7
  2. package/modules.json +7009 -2922
  3. package/package.json +44 -21
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- [![Explore Nuxt Modules to build Vue applications](https://user-images.githubusercontent.com/904724/210616249-25aec46e-ab06-4b4d-9154-10b02546d558.jpg)](https://nuxt.com/modules)
1
+ [![Explore Nuxt Modules to build Vue applications](https://github.com/user-attachments/assets/139f18eb-7bb1-4e37-8ef6-a94a60d6b0b0)](https://nuxt.com/modules)
2
2
 
3
3
  # Nuxt Modules
4
4
 
@@ -25,10 +25,22 @@ Example: `pnpm sync tailwindcss nuxt-modules/tailwindcss`
25
25
 
26
26
  To sync with a branch different than `main`, suffix the repo with `#repo-branch`, example: `pnpm sync tailwindcss nuxt-modules/tailwindcss#dev`
27
27
 
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`
29
+
28
30
  ### Contribution
29
31
 
30
- - If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
31
- - If some data is outdated please directly open a pull request
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.
32
44
 
33
45
  ### Using CDN
34
46
 
@@ -67,7 +79,7 @@ Field Name | Auto sync | Description
67
79
  `description` | Yes | Short description
68
80
  `repo` | No | GitHub repository. Format is `org/name` or `org/name#main/path`
69
81
  `npm` | Yes | NPM package name
70
- `icon` | No | Icon of module from [./website/public/icons](./website/public/icons) directory
82
+ `icon` | No | Icon of module from [./icons](./icons) directory
71
83
  `github` | No | GitHub URL
72
84
  `website` | No | Website URL
73
85
  `learn_more` | No | Link to learn more (website or relevant integration website)
@@ -75,6 +87,29 @@ Field Name | Auto sync | Description
75
87
  `type` | No | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
76
88
  `maintainers` | Yes | List of maintainers each item has `name`, `github` and `avatar`
77
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)
92
+
93
+ #### Providers
94
+
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:
96
+
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
104
+ ```
105
+
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
78
113
 
79
114
 
80
115
  ## Maintenance
@@ -95,10 +130,10 @@ pnpm build
95
130
 
96
131
  [MIT](./LICENSE) - Made by Nuxt Team
97
132
 
98
- [npm-version-src]: https://img.shields.io/npm/v/@nuxt/modules/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
99
- [npm-version-href]: https://npmjs.com/package/@nuxt/modules
133
+ [npm-version-src]: https://npmx.dev/api/registry/badge/version/@nuxt/modules
134
+ [npm-version-href]: https://npmx.dev/package/@nuxt/modules
100
135
 
101
- [nuxt-src]: https://img.shields.io/badge/Nuxt%20Modules-18181B?logo=nuxt.js
136
+ [nuxt-src]: https://img.shields.io/badge/Nuxt%20Modules-18181B?logo=nuxt
102
137
  [nuxt-href]: https://nuxt.com/modules
103
138
 
104
139
  [volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg