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

@lukechavers/jsdoc

v0.1.7

Published

A JSDoc theme and plugin collection based on Minami and Loke.

Downloads

12

Readme

Luke's JSDoc

Travis GitHub license NPM GitHub watchers

This project provides JSDoc and a collection of plugin's that I use for most of my JavaScript projects.

What does it do?

It abbreviates the necessary dependencies for our projects, allowing me to include fewer libraries for our JSDoc generation needs.

Why did I create it?

I wanted a simple way to add JSDoc documentation to all (or most) of my Javascript projects without needing to train each of my coworkers on the intricacies of JSDoc execution and configuration. My hope was that this, in turn, would lead to a wider adoption rate of JSDoc in my projects.

I also wanted to make my JSDoc output more consistent.

Installation

Use NPM to install this library as a devDependency of your project:

$ npm install --save-dev --save-exact lukes-jsdoc

Basic Usage

Step 1 - Create a JSDoc Config

conf/docs/html.json

{
	"source"        : {
		"include"        : [
			"lib",
			"package.json",
			"README.md"
		],
		"includePattern" : ".js$",
		"excludePattern" : "(node_modules/|docs)"
	},
	"opts"          : {
		"destination" : "./doc/html/",
		"template"    : "./node_modules/lukes-jsdoc"
	}
}

Step 2 - Execute JSDoc

$ cd /path/to/myproject
$ node node_modules/lukes-jsdoc/node_modules/jsdoc/jsdoc.js --configure conf/docs/html.json

Next Steps

The above example is a minimal implementation. You should, at least, add your documentation generation to an "npm script". More information about that is outlined in the Usage Document.

Documentation

Useful Links