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

documentation-theme-default

v3.0.0

Published

the default theme for documentation

Downloads

570

Readme

documentation-theme-default

Circle CI

This is the default theme for documentationjs: it consists of Handlebars templates and a few assets: a highlight.js theme and basscss as a basic CSS framework.

This is bundled by default in documentation: it is the default theme.

The contents are the following:

  • index.hbs, the main template that defines the document structure
  • section.hbs, a partial used to render each chunk of documentation
  • assets/*, any assets, including CSS & JS

Helpers

  • {{format_params}}: format function parameters, including the types included within.
  • {{permalink}}: in the context of a documentation chunk, return the chunk's permalink
  • {{autolink TEXT}}: given a chunk of text that may be a reference to a method, property, or other namespaced item, link the text to the item
  • {{md TEXT}}: render Markdown-formatted text, parsing additional JSDoc inline tag syntax and linking links when necessary
  • {{format_type}}: format a type definition, like {string} within a param definition.