npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ibook

v1.0.9

Published

markdown platform.

Downloads

3

Readme

Ibook

对文档信息,Koa,Koa-router的简单封装,适用于文档平台获取文档信息部分.

Input

|属性|说明|默认|是否必选 |---|---|---|--- |port|端口|8910|否 |ignoreDir|忽略文件夹名|无|否 |path|读取文档的路径|无|是 |dirname|目录对应名称|文件夹名称|否

Output

|属性|说明| |---|---| |app|koa实例 |router|koa-router对象| |files|文档的路径,标题信息|

其中files对象是文档目录递归后结果,数据结构如下

{
  walkArr: [
    // 当为文件夹的时候
    {
      // 子目录
      child: [
        // child中的结构与外层文件/文件夹层级一致
        ...
      ],
      // 显示的名称,和dirname中的信息一一对应
      displayName: '',
      // 文件名称
      itemName: '',
      // 文件路径
      path: '',
      // 文件类型,dir为文件夹,file为文件
      type: ''
    }]
    // 当为文件的时候
    {
      itemName: '',
      path: '',
      title: '',
      type: ''
    }
}