@nuxt/modules 0.6.0-ab4e91 → 0.6.0-abcb1f

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 +12 -2
  2. package/modules.json +577 -1315
  3. package/package.json +33 -24
package/README.md CHANGED
@@ -25,10 +25,20 @@ 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
+ 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.
40
+
41
+ If some data is outdated, please open a pull request with the fix.
32
42
 
33
43
  ### Using CDN
34
44