bbs_api_doc_builder_grunt_task

Grunt task for using API DOCS

grunt-bbs_api_doc_builder_grunt_task

Grunt task for using API DOCS

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

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

grunt.loadNpmTasks('grunt-bbs_api_doc_builder_grunt_task');

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

grunt.initConfig({
  bbs_api_doc_builder_grunt_task: {
    options: {
      // Task-specific options go here. 
    }
  },
});

Type: String Default value: ', '

A string value that is used to do something with whatever.

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  bbs_api_doc_builder_grunt_task: {
    options: {}
  },
});

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  bbs_api_doc_builder_grunt_task: {
      build:{
          options: {
              version: 1,
              basePath:'./dev/sside/nodejs/axalfred/api/'
          }
      }
 
    }
});
 
 

For importing the task in you projet use 'git clone git@bigbossstudio.git.beanstalkapp.com:/bigbossstudio/bbs_api_doc_builder_grunt_task.git'

And put this en your package.json

"version": "1.0.0",
    "scripts": {
        "preinstall": "npm install PATH_TO_GIT_CLONED"
    },
    "devDependencies": {
    }

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.

(Nothing yet)