如何记录 NPM 包？

在本文中，我们将了解如何编写 NPM 包的文档。文档是任何 NPM 包的重要组成部分，因为它提供了有关包方法以及如何使用它们的想法。好的文档让你的 npm 包成为流行的 npm 包。 npm 包的文档取决于许多因素，请参阅分步过程。

• NPM： Npm 是一个包管理器，用于下载 NodeJS 的包。
• NPM 包： Npm 包是一种在 NodeJS 代码库中添加依赖项的方法。

第 1 步：使 package.json 提供更多信息

package.json：是一个JSON文件，包含了npm包的所有信息，比如包的作者是谁，这个包依赖于其他哪个包。

上面的 package.json 包含的信息非常少，因此该包没有出现在搜索中，因为信息不足以搜索。

下面给出的package.json文件包含了如此完整的信息。

package.json文件完全取决于你的包，但一般格式也是这种类型。

第 2 步：使用图形创建 ReadMe.MD

Readme.MD：它是任何文档的主要部分，如果你想学习点击这里，它是用 Markdown 编写的。降价还能够包含图形和其他媒体内容，因此如果您想让读者更好地理解，请在其上使用连击图形和颜色。

有时你想让你的读者理解得很好，但不能只用文字来理解，那么你也可以使用图片、形状和颜色。

注意：下图是我们发布的包，如步骤 1所示 包.json文件

上面两个步骤非常简单，如果你想做更多的文档，那么你也可以创建一个 Web 应用程序。

第 3 步：描述 npm 包文档的 Web 应用程序

如果您想详细了解您的包裹，您也可以在网站上进行。它会给你更多的方便。我们可以有一个网站来描述你的包裹，这个包裹是如何工作的，等等。

结论：任何包的文档都是基于开发者的想法，我们给你一个大致的思路来创建你自己的npm包文档。如果您想了解有关文档的更多信息，请参阅本文。技术文档