返回

分享你的心血:将你的 library 提交到 cdnjs(2022 版)

前端

嗨,各位 JavaScript 大师!

在开发和维护 JavaScript 库的征程中,我们常常会面临一个关键问题:如何让我们的杰作触及更多的人?

答案就在这里:cdnjs,一个免费且流行的内容分发网络,专门托管 JavaScript 库和框架。将你的 library 提交到 cdnjs,意味着你的代码将被全世界各地的开发人员轻松获取和使用。

本指南将引导你完成将 library 提交到 cdnjs 的各个步骤,并分享一些专业提示,帮助你获得最大收益。

步骤 1:确保你的 library 符合条件

  • 你的 library 必须是开源的,并且遵循 MIT 或类似许可证。
  • 它必须是 JavaScript 编写,并且具有良好的文档记录。
  • 你的库应该对更广泛的开发人员社区有价值。

步骤 2:准备你的提交

  • 创建一个 GitHub 存储库,其中包含你的 library 代码。
  • 编写一个简短而简洁的 README.md 文件,概述你的 library 的目的和用法。
  • 包括一个清晰的 LICENSE 文件,指定你的 library 的许可条款。

步骤 3:填写提交表格

访问 cdnjs 网站,点击“提交库”按钮。填写提交表格,提供以下信息:

  • 你的库的名称
  • GitHub 存储库的 URL
  • 简要你的库
  • 你的库的许可证
  • 可选:你的库的网站或文档链接

步骤 4:等待审核

cdnjs 团队将审查你的提交,并在你的库符合要求后批准它。审核过程可能需要几天时间。

步骤 5:享受你的 CDN!

一旦你的库获得批准,它将被添加到 cdnjs CDN 中,并可以通过以下方式访问:

https://cdnjs.cloudflare.com/ajax/libs/<your-library-name>/<version>

例如,要访问 jQuery 3.6.0,你可以使用以下 URL:

https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js

专业提示

  • 使用长尾关键词优化你的提交: 在提交表格中,包括与你的库相关的长尾关键词。这将有助于搜索引擎发现并索引你的库。
  • 提供清晰的文档: 编写一份详细的 README.md 文件,详细介绍你的库的用法、功能和 API。
  • 主动参与 cdnjs 社区: 加入 cdnjs 讨论组或 Slack 频道,与其他库维护者互动并获得反馈。
  • 推广你的提交: 在社交媒体上分享你已提交的库,并通知相关社区。

通过将你的 library 提交到 cdnjs,你不仅可以提高其知名度和可用性,还可以为整个 JavaScript 开发生态系统做出贡献。

现在,就开始吧,让你的 JavaScript 宝藏被世界看到!