grunt-aglio

Grunt plugin to generate aglio documentation

npm install grunt-aglio
3 downloads in the last day
30 downloads in the last week
70 downloads in the last month

grunt-aglio

Grunt plugin to generate aglio documentation

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

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

grunt.loadNpmTasks('grunt-aglio');

The Aglio task

Overview

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

grunt.initConfig({
  aglio: {
    your_target:{
      files:{
        "dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
      },
      theme: "default",
      seperator: "\n"
    }
  },
})

Options

options.files

Type: object

An object with the key as the destination file with an array of src files. The src files will be concatted into a single file before being processed.

options.theme

Type: String Default value: default

The theme to use, defaults to the default theme. Possible values are default, flatly, slate and cyborg. You can also pass in the path to your custom Jade templates here.

options.seperator

Type: String Default value: empty string

When multiple source files are provided, the seperator is used to combine them together.

options.filter

Type: Function Default value: function(src){return src;}

The src is passed through this function before passed into aglio. You can use this step to automatically add any tags, CI badges or build revision content into the src. Windows users can take advantage of this function to remove '\r' characters so that snowcrash will parse their files properly

Usage examples

Basic

This configuration allows you to split your API definition across multiple files and have it concatted in.

grunt.initConfig({
  aglio: {
    your_target:{
      files:{
        "dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
      },
      theme: "slate"
    }
  },
})

Basic w/ Filter

This allows you to tag your documentation to a particular revision number that you may be using elsewhere

grunt.initConfig({
  aglio: {
    your_target:{
      files:{
        "dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
      },
      theme: "slate",
      filter: function(src){
        return "> This documentation is correct as of " + revNum + "\n" + src;
      }
    }
  },
})

Custom Jade Template

This configuration allows you to specify your own jade template. A guide on how to write your own can be found at the aglio repo.

grunt.initConfig({
  aglio: {
    your_target:{
      files:{
        "dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
      },
      theme: "slate"
    }
  },
})

Windows users

Adding this to your filter function will allow you to get rid of the the use of carriage return(s) '\r' in source data isn't currently supported, please contact makers error from snowcrash.

grunt.initConfig({
  aglio: {
    your_target:{
      files:{
        "dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
      },
      theme: "slate",
      filter: function(src){
        return src.replace(/\r/g, '');
      }
    }
  },
})

Changelog

0.1.5 - Made the task async, thanks to @ebonlieu

npm loves you