# generator-sassdoc-theme

> [Yeoman] generator that scaffolds out a [SassDoc] theme.

<br>
[![npm version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]

## Features

* Let you chose your preferred template engine
* Build the theme views and `index.js` based on prompts
* Default Sass starter structure
* Let you use a pre-defined Grunt or Gulp workflow
* Templates loaded with examples and comments


## Documentation

Theme generator documentation:

See [Theme generator](http://sassdoc.com/theme-generator)

SassDoc theme documentation:

* [Using Your Own Theme](http://sassdoc.com/using-your-own-theme)
* [SassDoc Data Interface](http://sassdoc.com/data-interface)
* [Themeleon theme engine](https://github.com/themeleon/themeleon/blob/master/README.md)


## Credits

* [Pascal Duez](https://twitter.com/pascalduez)
* [Valérian Galliat](https://twitter.com/valeriangalliat)
* [Fabrice Weinberg](https://twitter.com/fweinb)
* [Hugo Giraudel](http://twitter.com/HugoGiraudel)


## Licence

generator-sassdoc-theme is [unlicensed](http://unlicense.org/).


[Yeoman]: http://yeoman.io
[SassDoc]: https://github.com/SassDoc/sassdoc
[npm-url]: https://www.npmjs.org/package/generator-sassdoc-theme
[npm-image]: http://img.shields.io/npm/v/generator-sassdoc-theme.svg?style=flat-square
[travis-url]: https://travis-ci.org/SassDoc/generator-sassdoc-theme?branch=master
[travis-image]: http://img.shields.io/travis/SassDoc/generator-sassdoc-theme.svg?style=flat-square