Webdash 是一款基于浏览器的可视化开发工具，可以帮助开发者更方便快捷地构建 Web 应用程序。 webdash-readme-preview 是一款 Webdash 插件，它可以在 Webdash 中显示 npm 包的 README 文档预览，可以有效地帮助开发者更好地了解和使用当前的 npm 包。在本文中，我们将介绍 webdash-readme-preview 的使用教程，为开发者们提供更完整的 npm 包学习和使用指导。
安装 webdash-readme-preview
在使用 webdash-readme-preview 之前，我们需要先在 Webdash 中安装该插件。在 Webdash 中，点击菜单栏中的“插件”按钮，然后在插件搜索框中输入 "webdash-readme-preview"。在搜索结果中，点击 "webdash-readme-preview" 插件，即可在 Webdash 中安装该插件。
配置 webdash-readme-preview
在安装完 webdash-readme-preview 插件之后，我们还需要对插件进行配置，以确保插件能够正常工作。在 Webdash 中，点击菜单栏中的“插件”按钮，然后在插件列表中找到 "webdash-readme-preview" 插件。点击该插件，进入插件设置页面。
在插件设置页面中，我们需要配置三个参数：NPM registry URL、NPM search URL、NPM package URL，它们用于告诉 webdash-readme-preview 插件，从哪里获取 npm 包相关的信息。下面是这三个参数的具体设置方式：
1. NPM registry URL
NPM registry URL 是指 npm 包的注册地址，默认为 https://registry.npmjs.org/。如果你使用的是其他的 npm 包注册机构，需要将该地址修改为对应的注册地址。
2. NPM search URL
NPM search URL 是指进行 npm 包查询时的搜索地址，默认为 https://www.npmjs.com/search?q=。如果你使用的是其他的 npm 包查询网站，需要将该地址修改为对应的查询地址。
3. NPM package URL
NPM package URL是指 npm 包的查看地址，默认为 https://www.npmjs.com/package/。如果你使用的是其他的 npm 包查看网站，需要将该地址修改为对应的查看地址。
配置完成后，点击“保存设置”按钮即可保存配置。
使用 webdash-readme-preview
在完成以上的配置后，我们就可以在 Webdash 中使用 webdash-readme-preview 了。在 Webdash 的左侧菜单栏中，找到 "npm" 菜单，然后在搜索框中输入你想要查询的 npm 包名称。在搜索结果列表中，点击需要查询的 npm 包名称，即可进入该 npm 包的详细信息页面。
在 npm 包的详细信息页面中，我们可以看到该 npm 包的 README 文档预览。该文档预览支持 Markdown 格式，并显示了当前 npm 包的具体信息，如：版权信息、依赖关系、更新记录等。开发者们可以根据这些信息，更好地了解和使用当前的 npm 包。
示例代码
以下是一个使用 webdash-readme-preview 的示例代码：
-- -------------------- ---- -------
--------- -----
------
------
----------------------------- ------------
-------
------
---- ---------------------- ----- ------- --- ---
-------------------------- ---------
---- - ------- ---- ----- ---------- --- - ---
------ ------------------------ --- ------
---- -- --- ----------- ------ ---- ---
-------------------------- - ------ ---------
-------
-------总结
通过本文的介绍，我们了解到了如何使用 webdash-readme-preview 插件，在 Webdash 中预览 npm 包的 README 文档。该插件可以帮助开发者更好地了解和使用当前的 npm 包，为开发者们提供更完整的 npm 包学习和使用指导。同时本文中还包含了插件的配置和使用示例，希望能够对读者们有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671048dd3466f61ffdcac