返回介绍

模块作者指南 Module Author Guide

发布于 2024-04-18 00:42:18 字数 2754 浏览 0 评论 0 收藏 0

了解如何创建 Nuxt 模块以集成、增强或扩展任何 Nuxt 应用程序。

Nuxt 的 configurationhooks 系统使自定义 Nuxt 的各个方面并添加您可能需要的任何集成(Vue 插件)成为可能 、CMS、服务器路由、组件、日志记录等)。

Nuxt 模块 是在使用 nuxi dev 以开发模式启动 Nuxt 或使用 nuxi build 构建生产项目时顺序运行的功能。 使用模块,您可以将自定义解决方案封装、正确测试和共享为 npm 包,而无需向您的项目添加不必要的样板文件,也不需要更改 Nuxt 本身。

快速开始

我们建议您使用我们的 入门模板 开始使用 Nuxt 模块:

bash
npx nuxi init -t module my-module

这将创建一个“我的模块”项目,其中包含开发和发布模块所需的所有样板。

下一步:

  1. 在您选择的 IDE 中打开 my-module 2.使用你最喜欢的包管理器安装依赖
  2. 使用 npm run dev:prepare 准备用于开发的本地文件 4.按照本文档了解有关Nuxt Modules的更多信息

使用启动器

Nuxt 模块带有各种强大的 API 和模式,允许它们以几乎任何可能的方式改变 Nuxt 应用程序。 本节将教您如何利用这些。

模块剖析

Nuxt Module 生态系统 代表每月超过 1500 万次 NPM 下载,并提供扩展功能和与各种工具的集成。 你可以成为这个生态系统的一部分!

模块类型

官方模块 是带有前缀(作用域)的模块 @nuxt/ (例如 @nuxt/content)。 它们由 Nuxt 团队积极制作和维护。 与框架一样,我们非常欢迎来自社区的贡献,以帮助他们变得更好!

社区模块 是以“@nuxtjs/”为前缀(作用域)的模块(例如 @nuxtjs/tailwindcss)。 它们是由社区成员制作和维护的经过验证的模块。 同样,欢迎任何人的贡献。

第三方和其他社区模块是(通常)以 nuxt- 为前缀的模块。 任何人都可以制作它们,使用这个前缀可以让这些模块在 npm 上被发现。 这是起草和尝试想法的最佳起点!

私人或个人模块 是为您自己的用例或公司制作的模块。 他们不需要遵循任何命名规则来与 Nuxt 一起工作,并且经常在 npm 组织下看到范围(例如 @my-company/nuxt-auth

列出你的社区模块

欢迎将任何社区模块列在 模块列表 中。 要列出,在 nuxthttps://ezdoc.cn/modules 中打开一个问题 存储库。 Nuxt 团队可以帮助您在上市前应用最佳实践。

加入 nuxt-modules@nuxtjs/

通过将您的模块移动到 nuxt-modules,总有其他人可以提供帮助,这样我们就可以合力做出一个完美的解决方案。

如果你有一个已经发布和工作的模块,并且想将它转移到 nuxt-modules在 nuxthttps://ezdoc.cn/modules 中打开一个问题

通过加入 nuxt-modules,我们可以在 @nuxtjs/ 范围内重命名您的社区模块,并为其文档提供一个子域(例如 my-module.nuxtjs.org)。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文