创buildNPM包,如何logging它们?

我正在创build一些NPM包,我想知道为他们编写用户文档的最佳做法是什么(因为只有很less的信息,并且search与npm package documentation相关的任何内容都不可避免地产生npm docs自己)。

当你发布一个包时,registry从哪里得到头版文件?

我想有一个很好的README.md文件是任何浏览github回购的人的第一步,但我想提供一个方便的方式来阅读编译的JsDoc。

软件包的npm软件包页面从软件包中的package.json字段(名称,描述,依赖关系等)或npm数据库本身(下载图表,上次发布的,星号,依赖项)获取顶部表中的数据等等)。 下面的东西只是从markdown转换为HTML的README.md。

所以大部分软件包都有一个好的README.md 。 如果你想build立你的jsdoc到HTML并发布到某处(也许只是git回购本身),我会build议在README中显着的链接,并把它称为好的。

我发现一个有趣的包,使jsdoc中的README.md出来:

https://www.npmjs.org/package/jsdoc-to-markdown