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

v0.0.15

Published

Grunt module for using mox( A markdown javascript documentation generator)

Downloads

26

Readme

grunt-mox

Grunt module for using mox( A markdown javascript documentation generator)

Check out the example mox output here

Build Status

NPM

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-mox');

The "mox" task

Overview

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

grunt.initConfig({
  mox: {
    your_target: {
      sourceFiles : ['sourceFile1.js','sourceFile2.js'],
      options: {
        name: "Grunt-Mox",
        version:"0.1.0",
        template : "default",
        outputFile:"outputFile.md",
        moxJsonFile : "moxJsonFile.json",
        htmlFile : "htmlOutput.html"
      }
    },
  },
})

Paramaters

sourceFiles

Type: String | Array

Source file(s) or directories to get documentation from

Options

name

Type: String

Name of application or project generating documentation for.

version

Type: String

Version of documentation or application generating documentation for.

template

Type: String Default: default

Template used to generate documentation. Can be the path to a custom template or one of the predefined mox templates. See mox documentation for more details.

outputFile

Type: String

File path to output mox markdown documentation.

htmlFile

Type: String

File path to output dox html documentation.

moxJsonFile

Type: String

File path to output dox json object. See mox documentation for more details.

Usage Examples

Default Template

In this example, the default mox template will be used to generate documentation for the specfied source files.

grunt.initConfig({
  mox: {
    your_target: {
      sourceFiles:['sourceFile1.js','sourceFile2.js']
      options: {
        outputFile: 'outputFile.md'
      }
    },
  },
})

Mox Template

In this example, the category mox template will be used to generate documentation for the specfied source files.

grunt.initConfig({
  mox: {
    your_target: {
      sourceFiles:['sourceFile1.js','sourceFile2.js']
      options: {
        outputFile: 'outputFile.md',
        template: 'category'
      }
    },
  },
})

Custom Template

In this example, a custom jade template will be used to generate documentation for the specfied source files.

grunt.initConfig({
  mox: {
    your_target: {
      sourceFiles:['sourceFile1.js','sourceFile2.js']
      options: {
        outputFile: 'outputFile.md',
        template: 'someCustomTemplate.jade'
      }
    },
  },
})

## 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](http://gruntjs.com/).