node.js - 在哪里可以找到 npm 包的文档？

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

在哪里可以找到 npm 包的文档？

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

我尝试运行 npm docs textract ，但这只是将我带到了 GitHub 存储库。

rubygems.org 有一个给定 gem 的文档链接，但我在 npmjs.com 页面上找不到 textract 的等效内容。

(谷歌搜索的任何人请注意:this page 是关于同名的 Python 库)

Answer 1

I can't find any other documentation, analogous to what's written in RDoc for Ruby libraries.

该 README 文件是文档，类似于 RDoc 中为 Ruby 库编写的内容。

I tried running npm docs textract, but that just sent me to the GitHub repo.

因此，正如预期的那样，它确实将您转到了文档。

rubygems.org has a link to the documentation for a given gem, but I couldn't find the equivalent on the npmjs.com page for textract.

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

texttract 的文档在这里 - 这里有 12 个文档屏幕:

• https://www.npmjs.com/package/textract

您对文档内容是否满意是另一回事。如果您不同意，您应该发布带​​有更好文档的拉取请求。