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

recipe-doc

v1.1.0

Published

a cli tool and export comment for recipe

Downloads

3

Readme

recipe-doc

apidoc 注释抽取命令行工具, 导出的数据可以直接发送给 recipe 生成项目。

快速开始

# 全局安装 recipe-doc 命令行工具
$ npm i recipe-doc -g
# 显示帮助
$ recipe-doc --help

  Usage: recipe-doc [options] <path>

  a cli tool and export comment for recipe


  Options:

    -V, --version                 output the version number
    -p, --project <project_path>  project path
    -e, --export [export_path]    comments data export path
    -n, --name <file_name>        export file name (default: recipe.json)
    -c, --conf <config_file>      config file name (default: .reciperc)
    -h, --help                    output usage information

首先应在项目的根目录下新建一个 .reciperc 的配置文件,配置文件内容如下

{
  "isPublis": false,                  // 项目 api 文档是否公开
  "creator": {
    "type": "individual",             // 可选值为 individual(个人项目) 或 collective(团队项目)
    "name": "[email protected]"     // 若为个人项目,请提供个人对应的饿了么邮箱,否则提供团队名称
  },
  "dirs":"src"                        // 抽取注释的目录,可以为数组
}

注释遵循 apidoc 规范,上面工作准备完后:

$ recipe-doc -p ${project_path}

执行完成后,就可以在 recipe 看到你生成的项目啦。