创建NPM包，如何为它们编写文档？

Question

9

我正在创建一些NPM包，想知道编写用户文档的最佳实践是什么（因为相关信息很少，搜索与npm包文档有关的任何内容都不可避免地会导致npm文档本身）。

当您发布一个包时，注册表从哪里获取主页文档？

我猜测拥有一个漂亮的README.md文件是任何浏览github存储库的人的第一步，但我想提供一种方便的方式来阅读编译后的JsDoc。

- fortran

2个回答

3

我发现了一个有趣的包，可以从jsdoc中生成README.md文件：

- fortran

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Peter Lyons · Accepted Answer

该包的npm页面从您的包中的package.json字段（名称、描述、依赖项等）或者从npm数据库本身（下载图、最后发布时间、点赞数、依赖方等）获取表格上方的数据。下面的内容只是README.md从markdown转换到HTML的结果。

因此，大多数包都只需要一个好的README.md即可。如果您想要将jsdoc构建成HTML并在某处发布（也许只是git repo本身），我建议在README中突出显示链接并且调用它即可。