前言
在开发过程中,我们经常使用各种各样的第三方库,而每个库的文档格式也不尽相同。readme-please 是一款可以将 npm 包的文档转换成中文的工具,能够方便开发者在使用时快速了解该 npm 包的相关信息。
安装
使用 npm 安装 readme-please,执行如下命令即可:
--- ------- -- -------------
使用
在命令行中执行以下命令:
------------- --------------
其中,package-name 为 npm 包的名称。执行该命令后,readme-please 会将该 npm 包的 README 文件转换为中文,并输出到命令行中。
如果需要将转换后的文档保存为本地文件,可以使用以下命令:
------------- -------------- - -------------
其中,filename 为保存文件的路径和文件名。
示例
以常用的 axios 库为例,执行以下命令即可查看该库的中文文档:
------------- -----
输出信息如下:
----- ----- ----- ------- - ---- ---------- ------------ --------- ---- ----- ------ - ---- --------- -------- -- -- -- --- --- -------- - --- ------- -----
使用 CDN:
------- --------------------------------------------------------------------
使用 Bower 安装:
- ----- ------- -----
使用 GitHub 仓库直接下载并使用。请查看 GitHub Releases 获取 tarball 和 zipball 文件。
用法
请求一个 URL
--------------------------- -------------- ---------- - ---------------------- -- --------------- ------- - ------------------- ---
此外,还有一些其他的方式可以通过 axios 发送请求。请查看 文档中的例子 以获取更多信息。
axios(config)
您可以通过传递一个配置对象来创建一个请求。以下是所有可用的选项。必须至少提供 url
属性:
------- ------------ ------- ------ -------- ------------------------------- -------- -------------------- ------------------ ------- - --- ----- -- ----- - ---------- ------- --------- ------------ -- -------- ----- ------------- ------- -- -------------- ---------- - ---------------------- -- --------------- ------- - ------------------- ---
axios(url[, config])
如果只传一个参数,它就应该是一个 URL:
-------------------- -------------- ---------- - ---------------------- -- --------------- ------- - ------------------- ---
以上内容仅为摘要,更多详细信息请查看 axios 官方文档。
-- -- ------------- ------------ --- -------------------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------