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

dash-docset-generator

v1.0.0

Published

Generates Dash docsets from JSON, YAML, Markdown, and HTML.

Downloads

42

Readme

Dash docset generator

Install

$ npm install -g dash-docset-generator

Building custom docsets

The build command is build-dash-docsets, and it takes the following options:

$ build-dash-docsets

Usage: build-dash-docsets -i <input dir> [-o <output dir>]

Options:
  -i, --inputDir   The directory containing the source files to be converted
                   into a docset.                                     [required]
  -o, --outputDir  The directory in which to place the generated docset.
                                                    [string]  [default: "build"]
  -c, --config     The config file, if an "index.md" with YAML front matter
                   does not exist.                                      [string]

Writing custom docsets

See the example-docsets directory if you (like me) are not into reading about code.

Required config (all formats)

Regardless of the format of your custom docset, it needs to set a few configuration parameters to build correctly. Here's a sample config in YAML (JSON works too).

title: package.json (node.js)
bundle_name: NodePackageJSON
keyword: package.json
files: ["index.md", "../style-solarized-light.css"]
stylesheet: style-solarized-light.css
  • title: the title of the docset
  • bundle_name: The name of the generated .docset folder/bundle.
  • keyword: The shortcut keyword that will cause Dash to jump to this docset.
  • files: An array of filenames to be built and/or included in the docset.

Markdown

Markdown docsets are the simplest, as they can include the required YAML config as part of the .md file's front matter.

Here's an example:

---
title: package.json (node.js)
bundle_name: NodePackageJSON
keyword: package.json
files: ["index.md", "../style-solarized-light.css"]
stylesheet: style-solarized-light.css
---

package.json(5) -- Specifics of npm's package.json handling
===========================================================

@[toc](Contents)

## name

The *most* important things in your package.json are the name and version fields.

... which would come out something like this (there's still some micro-jank here and there, I know):

authors/contributors