我在哪里可以找到npm包的文档?
我正在尝试查找npm包textract的文档。我可以看到README file,但我找不到任何其他文档,类似于RDoc中为Ruby库编写的文档。特别是,我正在寻找在程序中运行它时如何将保留换行符设置为true,而不是命令行。我最终不得不看看cli.js是如何做到的。
我尝试运行npm docs textract
,但这只是将我发送到GitHub回购。
rubygems.org有一个给定gem的文档的链接,但我在npmjs.com页面上找不到textract的等效文件。
(注意任何人用谷歌搜索:this page是关于同名的Python库)
答案 0 :(得分:1)
我找不到任何其他文档,类似于RDoc中为Ruby库编写的文档。
该README文件是文档,类似于Ruby库中RDoc编写的内容。
我尝试运行npm docs textract,但这只是将我发送到GitHub回购。
所以它确实按照预期将您发送到文档。
rubygems.org有一个给定gem的文档的链接,但我在npmjs.com页面上找不到textract的等效文件。
npm有一个指向模块文档的链接。
textract的文档在这里 - 那里有12个文档屏幕:
您是否对文档内容感到满意是另一回事。如果你不是那样的话,你应该发布带有更好文档的拉取请求。