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

faxx

v0.6.1

Published

πŸ“  from repo/πŸ“ƒ ✨ wherever/πŸ“ƒ

Downloads

24

Readme

Faxx

It's fun keeping docs and the code to which it refers together, but docs need to get out and about to be useful! Faxx teleports docs from a GitHub repository to wherever you heart desires.

Development

Faxx is compiled with Babel, src => dist.

  • $ npm run build

Will watch and rebuild by default.

Usage

Install it everywhere

  • $ npm i -g faxx

Make faxx part of your build process.

  • $ npm i --save-dev faxx

Teleportation

  • $ faxx -r manifold/torus -o app/docs

Keep an eye on a local docs directory

  • $ faxx -l ../manifold/torus -o app.docs

See --help for additional options.

Import indexed documentation

Once the documentation is where you needed it, just import it.

import docs from './docs '

This assumes you're using babel-raw in tandem with some sort of md => ? transpiler.

Structure

β”œβ”€β”€ src
β”‚   β”œβ”€β”€ catalog.js          # Index documentation
β”‚   β”œβ”€β”€ download.js         # Download tars from GitHub
β”‚   β”œβ”€β”€ github.js           # Fetch GitHub releases
β”‚   β”œβ”€β”€ index.js            # Glue everything together
β”‚   β”œβ”€β”€ local.js            # Local watch and build
β”‚   β”œβ”€β”€ options.js          # Options
β”‚   β”œβ”€β”€ output.js           # Output to fs
β”‚   └── spinners.js         # Spinners (even sometimes work)
β”œβ”€β”€ dist                    # Compiled files
β”œβ”€β”€ docs
└── bin

Roadmap

  • [ ] Much needed refactor
  • [ ] Better (any) error messages
  • [ ] Serve fetched documentation
  • [ ] Examples, and better documentation

License

AGPL-3.0β€”see the tl;dr.