# grunt-coffeecup

> Compile CoffeeCup into HTML.

Latest version **0.1.0** (published 2013-03-22) · 0 weekly downloads

## Install

```sh
npm install grunt-coffeecup
pnpm add grunt-coffeecup
yarn add grunt-coffeecup
bun add grunt-coffeecup
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2013-03-22 |
| First published | 2013-03-22 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Louis Acresti |
| Maintainers | namuol |
| Keywords | gruntplugin, coffeecup, coffeescript, coffee-script |

## Links

- npm: https://www.npmjs.com/package/grunt-coffeecup
- Repository: https://github.com/namuol/grunt-coffeecup
- Issues: https://github.com/namuol/grunt-coffeecup/issues
- npm.io page: https://npm.io/package/grunt-coffeecup

## Dependencies (1)

- [coffeecup](https://npm.io/package/coffeecup.md) ~0.3.19

## Recent versions

- 0.1.0 (latest) — 2013-03-22
- 0.1.1 — 2013-03-22

## README

# grunt-coffeecup [![Build Status](https://secure.travis-ci.org/namuol/grunt-coffeecup.png?branch=master)](http://travis-ci.org/namuol/grunt-coffeecup)

Grunt task to compile [CoffeeCup](https://github.com/gradus/coffeecup) into HTML.

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

``` shell
npm install grunt-coffeecup --save-dev
```

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

```  coffeescript
grunt.loadNpmTasks 'grunt-coffeecup'
```

## The "coffeecup" task
_Run this task with the `grunt coffeecup` command._

Task targets, files and options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide.

### Options

Any items in the `options` object are passed to CoffeeCup's `render` function.

### Usage Example

``` coffeescript
grunt.initConfig
  # ... other configurations ...
  coffeecup:
    simple:
      files:
        'path/to/result.html': 'path/to/source.coffee'
    recurse:
      expand: true
      cwd: 'path/to'
      src: ['**/*.coffee']
      dest: 'path/to/dest'
      ext: '.html'
    custom_title:
      options:
        title: 'Sweet Title, Bro'
      files:
        'path/to/custom/result.html': 'path/to/custom/source.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](http://gruntjs.com/).

## Release History
 * 2013-03-18  v0.1.0  Bare minimum tests pass.

---
_Source: https://npm.io/package/grunt-coffeecup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._