Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Parse coffeescript to readable documentation

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 src
Octocat-spinner-32 tasks
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gruntfile.coffee
Octocat-spinner-32 LICENSE-MIT
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
README.md

grunt-chalkboard Build Status

Grunt task for Chalkboard

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-chalkboard');

Chalkboard task

Overview

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

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

Options

options.separator

Type: String Default value: linefeed

Concatenated files will be joined on this string.

Usage Examples

Basic option

grunt.initConfig({
  chalkboard: {
    options: {},
    files: {
      'dest/output.md': ['src/file1.coffee', 'src/file2.coffee'],
    },
  },
})

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-12-17   v0.2.2   Updated Chalkboard to v0.4.3
  • 2013-11-26   v0.2.1   Updated Chalkboard to v0.4.2
  • 2013-06-03   v0.1.0   Initial working commit.
Something went wrong with that request. Please try again.