2016-07-24 239 views
0

哪里可以找到npm软件包的文档?我在哪里可以找到npm软件包的文档?

我试图找到npm包textract的文档。我可以看到README file,但我找不到任何其他文档,类似于RDoc中为Ruby库编写的内容。特别是,我正在寻找如何在程序内运行保留换行符为true,而不是命令行。我最终不得不看看cli.js是如何做到的。

我试着运行npm docs textract,但那只是送我到GitHub回购。

ruby​​gems.org有一个指向给定gem文档的链接,但是我在npmjs.com页面找不到对应于textract的等效内容。

(注的人使用Google:this page是关于相同名称的Python库)

+0

您已经链接到自述文件中的“文档”。你在找什么? – mscdex

+0

@mscdex回应我编辑的问题。 –

回答

1

我无法找到任何其他文件,类似于什么写的RDoc的Ruby库。

该自述文件的文档,类似于RDoc中为Ruby库编写的内容。

我试着运行npm docs textract,但是那只是送我到GitHub仓库。

因此,它确实将您发送到文档,如预期的那样。

ruby​​gems.org有一个指向给定gem文档的链接,但我在npmjs.com页面找不到与textract等效的内容。

而npm有一个指向给定模块文档的链接。

为textract的文档是在这里 - 有文件存在的12个屏幕:

无论您满意的文档的内容则是另一回事。如果你不是这样,你应该发布一个更好的文档拉请求。

相关问题