grunt-piedmont

Generate a Living Styleguide based on a Frontend Prototype.

Getting Started

This plugin requires Grunt.

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

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

grunt.loadNpmTasks('grunt-piedmont');

The "piedmont" task

Overview

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

grunt.initConfig({
  piedmont: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.dest

Type: String Default value: './styling-guidelines'

Destination path of the generated living styleguide.

options.docs

Type: String Default value: ./test/fixtures/docs

Source path of markdown files that will be parsed and converted to content pages. Piedmont uses a glob pattern to get the files: ./test/fixtures/docs/*.md.

Documents section for further details.

options.src

Type: String Default value: './dist'

Path of the built frontend prototype.

options.styles

Type: String Default value: './src/sass'

Path to the annotated stylesheet files. Currently only Sass files are supported, so you have to specify the path only. Piedmont uses a glob pattern to get the files: ./src/sass/**/*.scss.

options.tmp

Type: String Default value: '.tmp/styleguide'

Temporary files directory.

Component Inventory

See the Piedmont documentation for further details about the component inventory.

Styleguide

See the Piedmont documentation for further details about the styleguide.

Documents

See the Piedmont documentation for further details about the documentation pages.

Release History

(Nothing yet)

License

Copyright (c) 2015 Tilman Justen. Licensed under the MIT license.