# Swanky
> A most elegant and unopinionated documentation framework

[![Build Status](https://travis-ci.org/swanky-docs/swanky-core.svg?branch=master)](https://travis-ci.org/swanky-docs/swanky-core)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/swanky-docs/swanky-core)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![codecov.io](https://codecov.io/github/swanky-docs/swanky-core/coverage.svg?branch=master)](https://codecov.io/github/swanky-docs/swanky-core?branch=master)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()

### Swanky Configuration File

The Swanky configuration file `swanky.config.yaml` defines the sections of the documentation, sources to build the documentation fron and any pre/post processing that needs to be done to generate your required documentation.

##### Parameters

Tag | Description | Example
:-- | :-----------| :------
title | This refers to the title of your documentation site  | Swanky Docs
output | Folder to build assets into  | ./build