# grunt-breakshots

> Create screenshots of html files per breakpoint

Latest version **0.2.0** (published 2013-09-11) · 0 weekly downloads

## Install

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

## 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.2.0 |
| Published | 2013-09-11 |
| First published | 2013-07-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | J. Tangelder |
| Maintainers | jtangelder |
| Keywords | gruntplugin |

## Links

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

## Dependencies (3)

- [jade](https://npm.io/package/jade.md) *
- [grunt](https://npm.io/package/grunt.md) ~0.4.1
- [phantomjs](https://npm.io/package/phantomjs.md) *

## Recent versions

- 0.2.0 (latest) — 2013-09-11
- 0.1.3 — 2013-09-11
- 0.1.2 — 2013-07-04
- 0.1.1 — 2013-07-04
- 0.1.0 — 2013-07-03

## README

# grunt-breakshots

> Create screenshots with a viewer of html files per breakpoint

This task takes with PhantomJS screenshots of your page, and store them in a folder. Also a nice viewer is generated, so you can browse the screenshots easily.
The files are opened at the given url, so make sure the files are reachable by url.


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

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

## The "breakshots" task

### Options

#### options.breakpoints
Type: `Array`
Default value: `[240,320,480,640,700,768,1024,1280]`

#### options.ext
Type: `String`
Default value: `'png'`
`jpg` is also possible.

#### options.cwd
Type: `String`
Default value: `'.'`

#### options.url
Type: `String`
Default value: `'http://localhost:8000/'`


### Usage Examples

#### Default Options
```js
grunt.initConfig({
  breakshots: {
    options: {},
    files: {
      'breakshots/': ['index.html','contact.html','**/*.html']
    },
  },
})
```


## 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/09/11 - 0.2.0 - Now open files by an url, fixes linking problems
- 2013/07/04 - 0.1.2 - Added a nice viewer html
- 2013/07/04 - 0.1.1 - Fixed Phantomjs issue
- 2013/07/03 - 0.1.0 - Initial

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