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-moduledoc

v0.5.2

Published

Creates a frontend module documentation

Downloads

2

Readme

grunt-moduledoc

Creates a frontend module documentation

Getting Started

This plugin requires Grunt ~0.4.5

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-moduledoc --save-dev

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

grunt.loadNpmTasks('grunt-moduledoc');

Documenting modules

Create a YAML file for each module.

A module must have:

  • A title: Legal characters are capital letters and underscores.
  • A dom: The HTML node type

File header.yml:

title: HEADER
dom: header

defines:

<header> ... </header>

Class

Typically a module will have a unique CSS class. We use the ui- prefix to denote ui modules, but that is optional.

title: HEADER
dom: header
class: ui-header

defines:

<header class="ui-header"> ... </header>

Type

A module can also optionally belong to a type. We use the type- prefix to denote a type. This allows us have a generic class across a number of modules.

title: HEADER
dom: header
type: type-header
class: ui-header

defines:

<header class="type-header ui-header"> ... </header>

Description

You can add a one line description to the module.

title: HEADER
description: The main site header.
dom: header
type: type-header
class: ui-header

Options

You can add one or more option classes to a module. An option class should in some way alter the display of the module. We use the opt- prefix to denote an option.

title: HEADER
description: The main site header.
dom: header
type: type-header
class: ui-header
options:
  - class: opt-dark
    description: Displays the header with a dark background and white text.
  - class: opt-minimal
    description: Displays a minimal header.

Contains

Most importantly, modules can contain other modules. Add them to the contains list. They will be linked in the documentation.

title: HEADER
description: The main site header.
dom: header
type: type-header
class: ui-header
options:
  - class: opt-dark
    description: Displays the header with a dark background and white text.
  - class: opt-minimal
    description: Displays a minimal header.
contains:
  - LOGO
  - NAV_MAIN

You will of course have to create module YAML files for each contained module, which can also contain modules.

Optional and multiple contains

You can add a suffix to a contained module to denote how often it can be contained.

contains:
  - REQUIRED
  - OPTIONAL ?
  - MULTIPLE +
  - OPTIONAL_MULTIPLE *

Modules without a suffix are considered required. Modules with ? are considered optional. Modules with + are considered multiple (i.e. one or more occurances). Modules with * are considered both optional and multiple (i.e. zero, one or more occurances).

Inner DOM wrappers

A module might often contain an inner wrapper that in turn contains the contained modules.

You can document this by adding it to the dom setting.

dom: div>div.wrapper
class: ui-block

defines:

<div class="ui-block">
  <div class="wrapper">
    <!-- modules go here -->
  </div>
</div>

You can also define the wrapper as its own module, e.g. WRAPPER, and then use that:

name: WRAPPER
dom: div
class: ui-wrapper
name: BLOCK
dom: div>WRAPPER
class: ui-block

defines:

<div class="ui-block">
  <div class="ui-wrapper">
    <!-- modules go here -->
  </div>
</div>

The "moduledoc" task

Overview

In your project's Gruntfile, add a section named moduledoc to the data object passed into grunt.initConfig().

grunt.initConfig({
  moduledoc: {
    my_target: {
      options: {
        // Task-specific options go here.
      },
      files: {
        // Target-specific file lists and/or options go here.
      }
    }
  },
});

Options

options.templatepath

Type: String Default value: templates/module.mustache

Path to the module template.

options.assetspath

Type: String Default value: templates/assets

Path to the assets directory.

Usage Examples

Default Options

grunt.initConfig({
  moduledoc: {
    dist: {
      options: {},
      files: {
        'dest/docs': ['src/docs'],
      },
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Tests

grunt test