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

sutro-jsdoc-theme

v1.1.0

Published

JSDoc theme based on Namis, based Minami

Downloads

788

Readme

Sutro

A clean, responsive, documentation template theme for JSDoc 3.

Based on Namis, which is based on based on Minami.

Sutro Screenshot

Uses

Install

$ npm install --save-dev sutro-jsdoc-theme

Usage

$ jsdoc entry-file.js -t node_modules/sutro-jsdoc-theme

You can customize the template in your jsdoc.conf.json file:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": "./src/",
        "includePattern": ".+\\.js$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "linenums": true,
        "includeDate": false,
        "title": "MathLive",
        "pageTitle": "MathLive Docs",
        "description": "Beautifully typeset math made easy",
        "keywords": "latex, tex, math, typesetting, documentation, docs",
        "forkme": "https://github.com/arnog/mathlive"
    },
    "opts": {
        "outputSourceFiles": true,
        "access": "all",
        "template": "node_modules/sutro-jsdoc-theme",
        "recurse": true,
        "destination": "./docs",
        "readme": "CONTRIBUTOR_GUIDE.md"
    }
}

The keys in the opts section are defined by JSDoc:

  • access: only display symbols with the given access property: private, protected, public, undefined or all.
  • recurse: when scanning for source files and tutorials, recurse directories.
  • destination: path to the output folder for the generated documentation
  • readme: the file to include in the generated documentation as the "home page"
  • outputSourceFiles: if true, include prettyfied source files in

The keys in the templates section are specific to Sutro:

  • cleverLinks
  • monospaceLinks the documentation
  • linenums: if true, include line numbers in prettyfied output
  • sourceCodeTheme: the color scheme used for the prettyfied source code: dark or light
  • sourceCodeBackground: a CSS background shorthand describing the background used to display source code. Defaults to dark or light color depending on sourceCodeTheme.
  • includeDate: if true, include date of documentation creation in footer
  • title: name of the "home" link, at the top left of the page
  • pageTitle: value of the <title> tag
  • description: value of the <description> tag
  • keywords: value of the <keywords> tag
  • forkme: if present, display a "Fork Me" banner, with a URL pointing to the value of this entry
  • headerAddendum and bodyAddendum: if present the content will be inserted in the template in the header and just before end the end body tag, respectively. This can be useful to add additional scripts in the template.

License

Licensed under the Apache2 license.