# grunt-acetate

> Grunt plugin for the Acetate.

Latest version **1.1.2** (published 2016-12-19) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-12-19 |
| First published | 2014-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Patrick Arlt |
| Maintainers | patrickarlt |
| Keywords | gruntplugin, acetate |

## Links

- npm: https://www.npmjs.com/package/grunt-acetate
- Repository: https://github.com/patrickarlt/grunt-acetate
- Homepage: https://github.com/patricklocal/grunt-acetate
- Issues: https://github.com/patricklocal/grunt-acetate/issues
- npm.io page: https://npm.io/package/grunt-acetate

## Recent versions

- 1.1.2 (latest) — 2016-12-19
- 1.1.1 — 2016-12-19
- 1.1.0 — 2016-10-24
- 1.0.0 — 2016-06-21
- 0.4.0 — 2016-01-05
- 0.3.0 — 2015-06-22
- 0.2.0 — 2015-04-26
- 0.1.0 — 2015-04-17
- 0.0.14 — 2015-04-13
- 0.0.13 — 2015-04-13
- 0.0.12 — 2015-04-11
- 0.0.11 — 2015-04-09
- 0.0.10 — 2015-04-04
- 0.0.9 — 2015-04-04
- 0.0.8 — 2015-04-04
- … 6 more at https://npm.io/package/grunt-acetate/versions

## README

# grunt-acetate

> Grunt plugin for the Acetate static site builter.

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

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-acetate --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-acetate');
```

## The "acetate" task

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

```js
grunt.initConfig({
  acetate: {
    build: {
      options: {
        mode: 'build'
      }
    },
  },
});
```

### Options

| Option      | Default        | Description |
| ----------  | -------------- | ----------- |
| `config`    | `'acetate.conf.js'`    | The name of your configuration file.
| `root`    | `process.cwd()`    | The root directory where you are working. This shoudl contain your `src` and `dest` folders.
| `src`    | `'src'`    | The folder where pages are located in
| `dest`    | `'build'`    | The folder where pages will be built.
| `mode` | `build` | The task that Acetate will run. Should be one of `server`, `watch` or `build`.
| `port`      | `8000`         | Integer. The port on which the webserver will respond.
| `host`      | `'localhost'`  | The hostname to server the website on.
| `log`       | `'info'`       | Logging level to use. Should be one of `debug`, `verbose`, `info`, `success`, `warn`, `error`, `silent`.
| `args` | `{}` | Any additonal arguments you want to be available under `acetate.args` in your config file.

### Usage Examples

#### Simple Build

A simple example that will build your entire project.

```js
grunt.initConfig({
  acetate: {
    build: {
      options: {
        mode: 'build'
      }
    },
  }
});
```

#### Acetate Server + Grunt Watch

It is recommened that you use Acetate's built in server for development since it automatically enables both live reload when pages change and faster startup and build speeds. Run the `watch` task after Acetate to keep the task alive indefinitly.

```js
grunt.initConfig({
  acetate: {
    dev: {
      options: {
        mode: 'server'
      }
    },
  },
  watch: {
    ...
  },
});

grunt.registerTask('default', ['acetate:dev', 'watch']);
```

#### Acetate Watch + Grunt Watch

If you prefer to user your own server to serve files built by Acetate insteed of the built-in Acetate server you can use the built-in file watcher for Acetate.

```js
grunt.initConfig({
  acetate: {
    dev: {
      options: {
        mode: 'watch'
      }
    },
  },
  watch: {
    ...
  },
  connect: {
    ...
  }
});

grunt.registerTask('default', ['acetate:dev', 'connect', 'watch']);
```

#### Acetate Watch + Grunt Concurrent

If you are using [grunt-concurrent](https://github.com/sindresorhus/grunt-concurrent) to run your tasks in parrallel with either the built-in Acetate server or watcher make sure you specify the `keepalive` option.

```js
grunt.initConfig({
  acetate: {
    watch: {
      options: {
        mode: 'watch',
        keepalive: true
      }
    }
  },
  watch: {
    ...
  },
  connect: {
    ...
  },
  concurrent: {
    dev: ['acetate:watch', 'connect', 'watch'],
  }
});

grunt.registerTask('default', ['concurrent:dev']);
```

## 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

_(Nothing yet)_

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