ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

如何在npm官网上发表自己的包

2022-07-09 18:34:15  阅读:216  来源: 互联网

标签:npm i5ting unpublish 发布 文档 README 发表 网上


官网传送门

首先给大家推荐一个小工具i5ting_toc

i5ting_toc

i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具,使用步骤如下:

相对路径的图片

规范的包结构

一个规范的包,它的组成结构,必须符合以下 3 点要求:

  1. 包必须以单独的目录而存在。
  2. 包的顶级目录下要必须包含 package.json 这个包管理配置文件
  3. package.json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口。

注意:

  1. 以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考如下网址:包规范文档

  2. 在开发包的时候要最好按照要求开发,否则你写的包其他程序猿是很难去理解和应用的。

在了解这些后,你就可以开始开发自己的包了!开发过程结束后就需要写说明文档了。

编写包的说明文档

  1. 包根目录中的 README.md 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown 的格式写出来,方便用户参考。
  2. README 文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。我们所创建的这个包的 README.md 文档中,会包含以下 6 项内容:
  3. 安装方式、导入方式、格式化时间、转义 HTML 中的特殊字符、还原 HTML 中的特殊字符、开源协议

发布包

  1. 注册 npm 账号
  2. 登录 npm 账号

npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功。

注意:

在运行 npm login 命令之前,必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败!

  1. 把包发布到 npm 上
    将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)。

  2. 删除已发布的包

运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包。

注意:

  1. npm unpublish 命令只能删除 72 小时以内发布的包
  2. npm unpublish 删除的包,在 24 小时内不允许重复发布
  3. 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包!

标签:npm,i5ting,unpublish,发布,文档,README,发表,网上
来源: https://www.cnblogs.com/liyublogs/p/16461587.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有