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

fdoc

v0.0.5

Published

FDoc for NodeJS. Fdoc is made by Square

Downloads

35

Readme

FDoc for Node

FDoc is written by Square https://github.com/square/fdoc

I didn't want to learn Ruby, so I made it in NodeJS.

(p.s more documentation soon!)

Extra Features

In your .fdoc.service file you can have models:

models:
 loan:
  description: A loan on the system
  properties:
   id:
    type: int
    description: unique id
   equipment:
    type: object
    model: equipment
    description: piece of equipment associated with the loan

Which are used like so:

responseParameters:
 type: json
 properties:
  results:
   type: array
   model: loan

Also it is not as strict, so most things will work.

Plus, you may have noticed the type parameter. That formats the example. You can choose:

  • json
  • get (?g=4&ee=f)
  • form (g=4&ee=f)
  • (want more, add it to lib/type.mustache)

Credits

  • Square for making fdoc
  • Foundation CSS by ZURB which made the HTML generated look nice

License

GPL v3 - http://www.tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)