grunt-csstoc

grunt-csstoc

Generate table of contents (TOC) for CSS files (also works with LESS and SASS)

Getting Started

This plugin requires Grunt ~0.4.0

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

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

grunt.loadNpmTasks('grunt-csstoc');

The "csstoc" task

Overview

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

grunt.initConfig({
  csstoc: {
    dist: {
      options: {
        // Task-specific options go here.
      },
      files: {
        // your files here
      }
    }
  },
})

Options

options.sectionString

Type: String Default value: 'section'

A string value that is used to do identify TOC entries.

options.tocHead

Type: String Default value: 'Table Of Contents'

A string value that is used as headline for the TOC

Usage Examples

Default Options

In this example, the PlugIn will read all the @tocitem entries from the CSS file and generates the TOC from these entries.

grunt.initConfig( {
  csstoc: {
    dist: {
      options: {
        sectionString: 'tocitem',
        tocHead: 'Table Of Contents'
      },
      files: {
        'dest/mycss.css': 'src/mycss.css',
      },
    }
  },
} )

CSS File

How the TOC entries should look like:

/**
 * @section 1. Foo
 **/

.foo {
    height: 20px
}

/**
 * @section 2. Bar
 **/

/**
 * @section 2.1 Subentry
 **/
.foo .bar {
    background-color: red
}

Contributing

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.

Release History

• 2013-07-03   v0.2.0   Included grunt watch task, option for TOC head string
• 2013-06-30   v0.1.0   First official release, still BETA