Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

dirtydocs

v0.0.1

Published

2 years ago

Quick and dirty single page docs from JSDoc doclets

Downloads

5

0High
0Medium
0Low

Dirty Docs

Quick and dirty single page docs from JSDoc doclets.

Warning: Very simplistic, only currently handles classes, may not work for you!

Why

I wanted to include the API docs for a very simple JS project directly within the README file.
The source already had JSDoc style comments and I didn't want to manually duplicate them in the README.

How

Once installed a dirtydocs executable should be found in node_modules/.bin which accepts JSDoc doclet JSON on stdin and the path to a nunjucks template file as it's first argument. The JSON is transformed to make it more suitable for use within the template before the template is rendered and the results output to stdout.

Install

npm install dirtydocs

NOTE: JSDoc will be installed as a peer dependency.

Usage

Assuming you have installed locally, to run the example:

node_modules/.bin/jsdoc --explain node_modules/dirtydocs/examples/code.js | node_modules/.bin/dirtydocs node_modules/dirtydocs/examples/README.md

To run against your own source using the example template:

node_modules/.bin/jsdoc --explain path/to/source.js | node_modules/.bin/dirtydocs node_modules/dirtydocs/examples/README.md

When designing your own template you can view the object that will be passed to the template as JSON by omitting the template argument:

node_modules/.bin/jsdoc --explain path/to/source.js | node_modules/.bin/dirtydocs

License

MIT (c) Matt Walker