yocto-doc

Overview

This module generate documentation from source.

Documentation was builded with jsDoc and with customized postman-jsdoc-theme.

How to use ?

First install with npm command.

# If you install from npm registry
npm install yocto-doc --save-dev

After that configure your project's Gruntfile with a new section named yoctodoc (see below).

grunt.initConfig({
  yoctodoc : {
      options : {
        // change your path destination
        destination : 'Your_new_absolute_destination_path'
      },
      // Set all your file here
      all : [ 'file.js', 'file2.js', 'file3.js', 'OR a path all js files are added' ]
    }
});

// load task
grunt.loadNpmTasks('yocto-doc');
// register task
grunt.registerTask('doc', 'yoctodoc');

And run grunt command

grunt doc

How to add external files on documentation directory ?

To use this feature you can use copyExtraFiles property on your grunt file. You can use full path or wilcard to find wanted files.

grunt.initConfig({
  yoctodoc : {
      options : {
        // change your path destination
        destination : 'Your_new_absolute_destination_path'
        copyExtraFiles : [ 'mayfile.myextension', './directory/myfile.extension', './directory/*.js' ]
      },
      // Set all your file here
      all : [ 'file.js', 'file2.js', 'file3.js', 'OR a path all js files are added' ]
    }
});

How looks like the custom theme ?

See below kind of examples.

Changelog

2.1.6 (2016/12/05)

• Update CSS font for documentation