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

grunt-contrib-yuidoc

v1.0.0

Published

Compile YUIDoc Documentation

Downloads

6,711

Readme

grunt-contrib-yuidoc v1.0.0 Build Status: Linux Build Status: Windows

Compile YUIDoc Documentation

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-contrib-yuidoc --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-contrib-yuidoc');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Yuidoc task

Run this task with the grunt yuidoc command.

Visit the YUIDoc project home for more information on YUIDocs and commenting syntax.

Options

Settings mirror YUIDoc config.

Usage Examples

grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),
  yuidoc: {
    compile: {
      name: '<%= pkg.name %>',
      description: '<%= pkg.description %>',
      version: '<%= pkg.version %>',
      url: '<%= pkg.homepage %>',
      options: {
        paths: 'path/to/source/code/',
        themedir: 'path/to/custom/theme/',
        outdir: 'where/to/save/docs/'
      }
    }
  }
});

Release History

  • 2015-08-24   v1.0.0   Bump yuidocjs version to v0.10.0. peerDeps updates. doc updates.
  • 2015-08-24   v0.10.0   Update to yuidocjs ^0.9.0.
  • 2015-06-29   v0.9.0   Update to yuidocjs 0.8.0.
  • 2015-05-11   v0.8.0   Update to yuidocjs 0.7.0.
  • 2015-01-21   v0.7.0   Update to yuidocjs 0.5.0.
  • 2014-12-28   v0.6.0   Update to yuidocjs 0.4.0.
  • 2014-03-12   v0.5.2   Make sure to write JSON data with 'parseOnly'
  • 2014-02-24   v0.5.1   Fixes 'parseOnly' callback
  • 2013-09-01   v0.5.0   Catches and reports errors thrown by YUIDoc with grunt.warn.
  • 2013-02-15   v0.4.0   First official release for Grunt 0.4.0.
  • 2013-01-23   v0.4.0rc7   Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
  • 2013-01-09   v0.4.0rc5   Updating to work with grunt v0.4.0rc5.
  • 2012-10-12   v0.3.2   Rename grunt-contrib-lib dep to grunt-lib-contrib.
  • 2012-10-01   v0.3.1   Project options are parsed as templates.
  • 2012-09-23   v0.3.0   Options no longer accepted from global config key.
  • 2012-09-10   v0.2.0   Refactored from grunt-contrib into individual repo.

Task submitted by George Pantazis

This file was generated on Fri Mar 04 2016 17:16:16.