Documentary

Beautiful code documentation for your Meteor projects.

Uses an improved Docstrap template for JSDoc 3 to generate documentation for your packages or application code.

Install with Meteorite

Install with: mrt add documentary

This will download the package with the template and plugins into the packages folder within your Meteor app. This package does not include any code for your application, it just provides the template files for your JSDoc setup, so you don't have to copy those files around for every package.

Configuration

You have to use JSDoc 3 and tell it to use the template provided by this package.

Install grunt packages

Create package.json within your package folder like this:

{
  "name": "your-package",
  "description": "…",
  "version": "0.1.0",
  "engines": {
    "node": ">= 0.6.0"
  },
  "devDependencies": {
    "grunt": "~0.4",
    "grunt-jsdoc": "~0.4.2",
    "grunt-contrib-clean": "~0.5.0"
  }
}

Install grunt and the needed packages via npm install

Configure Grunt

Create Gruntfile.js in your package root folder like this:

module.exports = function (grunt) {
  "use strict";

  grunt.initConfig({

    pkg: '<json:package.json>',

    jsdoc : {
      dist : {
        src: ['source/**/*.js', 'documentation/index.md'],
        options: {
          destination: 'documentation/output',
          template: '../documentary/source/template',
          configure: 'documentation/jsdoc.conf.json',
          tutorials: 'documentation/tutorials'
        }
      }
    },

    clean: {
      documentation: ["documentation/output"]
    }
  });

  grunt.loadNpmTasks('grunt-jsdoc');
  grunt.loadNpmTasks('grunt-contrib-clean');

  grunt.registerTask('docs', ['clean:documentation', 'jsdoc:dist']);

};

Copy JSDoc example configuration file

This package includes an example configuration file for jsdoc. You have to copy it into your package and reference it in the Gruntfile.js jsdoc options.

With the Gruntfile.js above you have to copy the jsdoc.conf.example.json contained in the source folder of this package to documentation/jsdoc.conf.json in your package.

The jsdoc configuration file provides several options to customize the output of the template including footers, copy right sections etc.

For more information on docstrap theme configuration see Docstrap documentation

Release History

Version 0.1.0

License

Copyright (c) 2013 Code Adventure Licensed under the MIT license.