@nuxt/modules 0.5.0-fd7bbb → 0.6.0-d2962e
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/LICENSE +21 -0
- package/README.md +101 -0
- package/modules.json +915 -74
- package/package.json +30 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Nuxt Team
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
[](https://nuxt.com/modules)
|
|
2
|
+
|
|
3
|
+
# Nuxt Modules
|
|
4
|
+
|
|
5
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
6
|
+
[![Volta][volta-src]][volta-href]
|
|
7
|
+
|
|
8
|
+
> Discover the Nuxt modules to add any CMS, Database, UI, Auth and integrations into your Vue application.
|
|
9
|
+
|
|
10
|
+
- 🔗 [Modules listing](https://nuxt.com/modules)
|
|
11
|
+
- 📖 [Module author guide](https://nuxt.com/docs/guide/going-further/modules)
|
|
12
|
+
|
|
13
|
+
## Modules Database
|
|
14
|
+
|
|
15
|
+
Metadata of nuxt modules are maintained in [yml](https://en.wikipedia.org/wiki/YAML) files inside [./modules](./modules) directory and automatically synced from upstream to fetch latest information.
|
|
16
|
+
|
|
17
|
+
### Add/Update a module
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm sync <name> <repo>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Example: `pnpm sync tailwindcss nuxt-modules/tailwindcss`
|
|
24
|
+
|
|
25
|
+
To sync with a branch different than `main`, suffix the repo with `#repo-branch`, example: `pnpm sync tailwindcss nuxt-modules/tailwindcss#dev`
|
|
26
|
+
|
|
27
|
+
### Contribution
|
|
28
|
+
|
|
29
|
+
- If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
|
|
30
|
+
- If some data is outdated please directly open a pull request
|
|
31
|
+
|
|
32
|
+
### Using CDN
|
|
33
|
+
|
|
34
|
+
Compiled JSON data is available from following CDNs:
|
|
35
|
+
|
|
36
|
+
- **jsdelivr:** https://cdn.jsdelivr.net/npm/@nuxt/modules@latest/modules.json
|
|
37
|
+
- **unpkg:** https://unpkg.com/@nuxt/modules@latest/modules.json
|
|
38
|
+
|
|
39
|
+
### Using npm package
|
|
40
|
+
|
|
41
|
+
You can use the `@nuxt/modules` package by installing it in your project:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# npm
|
|
45
|
+
npm install @nuxt/modules
|
|
46
|
+
|
|
47
|
+
# pnpm
|
|
48
|
+
pnpm add @nuxt/modules
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Then you can directly import the list of modules:
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
// ESM
|
|
55
|
+
import modules from '@nuxt/modules'
|
|
56
|
+
|
|
57
|
+
// CommonJS
|
|
58
|
+
const modules = require('@nuxt/modules')
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Schema
|
|
62
|
+
|
|
63
|
+
Field Name | Auto sync | Description
|
|
64
|
+
----------------|-----------|--------------
|
|
65
|
+
`name` | No | Canonical name or integration name
|
|
66
|
+
`description` | Yes | Short description
|
|
67
|
+
`repo` | No | GitHub repository. Format is `org/name` or `org/name#main/path`
|
|
68
|
+
`npm` | Yes | NPM package name
|
|
69
|
+
`icon` | No | Icon of module from [./website/public/icons](./website/public/icons) directory
|
|
70
|
+
`github` | No | GitHub URL
|
|
71
|
+
`website` | No | Website URL
|
|
72
|
+
`learn_more` | No | Link to learn more (website or relevant integration website)
|
|
73
|
+
`category` | No | Module category from [./lib/categories.ts](./lib/categories.ts)
|
|
74
|
+
`type` | No | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
|
|
75
|
+
`maintainers` | Yes | List of maintainers each item has `name`, `github` and `avatar`
|
|
76
|
+
`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.
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## Maintenance
|
|
80
|
+
|
|
81
|
+
### Auto update all current modules
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
pnpm sync
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Generate `modules.json`
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
pnpm build
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
[MIT](./LICENSE) - Made by Nuxt Team
|
|
96
|
+
|
|
97
|
+
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/modules/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
98
|
+
[npm-version-href]: https://npmjs.com/package/@nuxt/modules
|
|
99
|
+
|
|
100
|
+
[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
|
|
101
|
+
[volta-href]: https://volta.net/nuxt/modules?utm_source=readme_nuxt_modules
|