# grunt-wintersmith-compile

> A grunt task for wintersmith build process.

Latest version **0.1.1** (published 2013-06-05) · 0 weekly downloads

## Install

```sh
npm install grunt-wintersmith-compile
pnpm add grunt-wintersmith-compile
yarn add grunt-wintersmith-compile
bun add grunt-wintersmith-compile
```

## 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.1 |
| Published | 2013-06-05 |
| First published | 2013-06-03 |
| 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 | vohedge |
| Maintainers | vohedge |
| Keywords | gruntplugin, wintersmith |

## Links

- npm: https://www.npmjs.com/package/grunt-wintersmith-compile
- Repository: https://github.com/vohedge/grunt-wintersmith-compile
- Issues: https://github.com/vohedge/grunt-wintersmith-compile/issues
- npm.io page: https://npm.io/package/grunt-wintersmith-compile

## Dependencies (1)

- [wintersmith](https://npm.io/package/wintersmith.md) ~2.0.5

## Recent versions

- 0.1.1 (latest) — 2013-06-05
- 0.1.0 — 2013-06-03

## README

# grunt-wintersmith-compile

> A grunt task for "wintersmith build" command.

## 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-wintersmith-compile --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-wintersmith-compile');
```

## The "wintersmith_compile" task

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

```js
grunt.initConfig({
  wintersmith_compile: {
    your_target: {
      options {
        config: 'path/to/config.json',
        output: 'path/to/build'
      }
    }
  },
})
```

### Options

#### config
Type: `String`
Default value: `'config.json'`

A string value that is a path to config.json.
By default, this task tries to find config.json from the same directory as Gruntfile.

#### output
Type: `String`
Default value: `'build'`

A string value that is a path to output directory.

### Usage Examples

#### Default Options
```js
grunt.initConfig({
  wintersmith_compile: {
    your_target: {}
  },
})
```

#### Custom Options

```js
grunt.initConfig({
  wintersmith_compile: {
    your_target: {
      options: {
        config: 'path/to/config.json',
        output: 'path/to/build'
      }
    }
  }
})
```

## Release History
_(Nothing yet)_

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