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

spm-doc

v0.3.2

Published

A documentation generator.

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

leptureleptureafc163afc163

Keywords

spmplugin

Readme

spm-doc

A CMD module documentation generator.

Install

Install spm-doc with npm:

$ npm install spm-doc -g

Usage

Build the documentation:

$ spm-doc build [options]

If you have installed spm2:

$ spm doc build [options]

Start a server at 127.0.0.1:8000:

$ spm doc server

Start a server at 127.0.0.1:8000, watching the source files change:

$ spm doc watch

Publish documentation to spmjs.org:

$ spm doc publish [options]

Clean the _site folder:

$ spm doc clean

Themes

The default theme path is ~/.spm/themes.

Install a theme:

git clone git://github.com/spmjs/nico-cmd.git ~/.spm/themes/cmd

The default theme nico-cmd would be installed when spm-doc is installed.

How to write a document

Follow the instruction in nico-cmd.

Changelog

0.3.2

  • fixed missing color in cli
  • fixed #5
  • update nico version

0.3.1

  • add callback argument

0.3.0

  • use CMD theme as default theme

0.2.8

  • remove spm-grunt
  • nico 0.4.4

0.2.7

  • nico 0.4.3

0.2.1

  • Fix the sync execute problem.
  • Fix the theme choosing logic.