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

@sugarcrm/jsdoc-baseline

v0.0.3

Published

A basic template for JSDoc 3.

Downloads

2

Readme

Baseline

Build Status

An extensible template for JSDoc 3.

This is a preview version of the Baseline template. Baseline is still under active development. Everything in the template is subject to change.

What is Baseline?

Baseline is a new HTML template for JSDoc 3. It offers several benefits:

  • Extensible from the ground up. You can use extensions to customize your documentation's content and appearance without changing Baseline itself. In addition, you can localize the headings and other text that are added by the template. Note: Customization options are limited in this preview version. More options will be available soon.
  • Easy to navigate. An expandable table of contents helps users find what they're looking for. Also, a summary at the top of each page shows users what's documented on that page.
  • Modern template syntax. Baseline uses Handlebars, a powerful JavaScript template engine, to define the template layout. Handlebars makes it possible to define new tags and helpers that you can use in your customizations to Baseline.

Installing Baseline

  1. Install JSDoc.

    Note: Baseline currently requires JSDoc 3.4.0 or later.

    To install JSDoc globally (may require sudo):

     npm install -g jsdoc

    To add JSDoc to your Node.js project as a development dependency:

     npm install --save-dev jsdoc
  2. Add the Baseline template to your Node.js project as a development dependency:

     npm install --save-dev @sugarcrm/jsdoc-baseline

Configuring and Using Baseline

To use the Baseline template with its default settings, simply run JSDoc with the --template (or -t) command-line option:

jsdoc --template <path/to/baseline> <path/to/js-files>

To use the Baseline template with customized settings:

  1. Copy baseline-config.json.EXAMPLE to a new file (for example, baseline-config.json).

  2. Modify the configuration file as needed. See baseline-config.json.EXAMPLE for information about the supported options. You can use comments in the configuration file.

  3. Update your JSDoc conf.json file to include a templates.baseline property. This property must contain the path to your Baseline configuration file.

  4. Run JSDoc as shown above, using the --configure (or -c) option to tell JSDoc where to find your conf.json file:

     jsdoc --configure <path/to/conf.json> --template <path/to/baseline> <path/to/js-files>

Note: Future versions of Baseline will provide additional configuration settings, including settings for overriding and modifying portions of the template.

Legal stuff

Copyright 2014-2015 Google Inc. Licensed under the Apache License, Version 2.0.

See LICENSE.md for more information.