https://github.com/rodleviton/generator-swanky

A most elegant and unopinionated documentation framework
https://github.com/rodleviton/generator-swanky

Last synced: about 2 months ago
JSON representation

A most elegant and unopinionated documentation framework

• Host: GitHub
• URL: https://github.com/rodleviton/generator-swanky
• Owner: rodleviton
• License: mit
• Created: 2016-04-17T07:25:32.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-17T22:29:12.000Z (about 9 years ago)
• Last Synced: 2024-12-15T02:12:19.890Z (6 months ago)
• Language: JavaScript
• Size: 22.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-swanky 

[![Build Status](https://travis-ci.org/rodleviton/swanky.svg?branch=master)](https://travis-ci.org/rodleviton/generator-swanky)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/rodleviton/generator-swanky)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![codecov.io](https://codecov.io/github/rodleviton/generator-swanky/coverage.svg?branch=master)](https://codecov.io/github/rodleviton/generator-swanky?branch=master)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()

> A most elegant and unopinionated documentation generator

## Installation

First, install [Yeoman](http://yeoman.io) and generator-swanky using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash

npm install -g yo

npm install -g generator-swanky

```

Then generate your new project:

```bash

yo swanky

```

## Getting To Know Yeoman

 * Yeoman has a heart of gold.

 * Yeoman is a person with feelings and opinions, but is very easy to work with.

 * Yeoman can be too opinionated at times but is easily convinced not to be.

 * Feel free to [learn more about Yeoman](http://yeoman.io/).

## License

MIT © [Rod Leviton](rodleviton.com)

[npm-image]: https://badge.fury.io/js/generator-swanky.svg

[npm-url]: https://npmjs.org/package/generator-swanky

[travis-image]: https://travis-ci.org/rodleviton/generator-swanky.svg?branch=master

[travis-url]: https://travis-ci.org/rodleviton/generator-swanky

[daviddm-image]: https://david-dm.org/rodleviton/generator-swanky.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/rodleviton/generator-swanky

[coveralls-image]: https://coveralls.io/repos/rodleviton/generator-swanky/badge.svg

[coveralls-url]: https://coveralls.io/r/rodleviton/generator-swanky