grunt-sassdoc

grunt-sassdoc

SassDoc grunt task.

Getting Started

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, install this plugin with this command:

npm install --save-dev grunt-sassdoc

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

grunt.loadNpmTasks('grunt-sassdoc');

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Documentation

See the Gruntfile in this repo for a full example.

Example config

grunt.initConfig({
  sassdoc: {
    default: {
      src: 'test/sass',
      dest: 'test/docs',
      display: {
        title: 'My cool project'
        private: true,
        alias: true
      }
    }
  }
});

grunt.loadNpmTasks('grunt-sassdoc');
grunt.registerTask('default', ['sassdoc']);

Authors

Pascal Duez

Licence

grunt-sassdoc is unlicensed.