> A simple, flexible and powerful ecosystem for creating beautiful documentation. [](http://npm.im/swanky) [](https://travis-ci.org/swanky-docs/swanky) [](https://github.com/swanky-docs/swanky) [](http://commitizen.github.io/cz-cli/) [](https://codecov.io/github/swanky-docs/swanky?branch=master) [](https://opensource.org/licenses/MIT) ### What is Swanky Docs? Swanky Docs is a framework that enables you to create beautiful documentation from any source. Swanky Docs is basically a static site generator that has been specifically designed to build documentation. Because Swanky Docs can be easily configured to 'stitch' together multiple sources of content it lends itself very well to building [Pattern Libraries](https://patterns.swanky-docs.org/). ### Why Swanky Docs? Unlike many other documentation tools that are focused on building documentation from one type of source e.g. [JSDocs](http://usejsdoc.org/), [Markdown](https://daringfireball.net/projects/markdown/), [Swagger](http://swagger.io/) etc. Swanky Docs can be configured to process multiple source types to build a comprehensive documentation asset, it can even combine multiple source types into single pages. --- ## Quick Start Guide Swanky can be installed independently or configured for you using the [swanky-cli](https://github.com/swanky-docs/swanky-cli) tool. If you encounter any problems, please submit a [GitHub issue](https://github.com/swanky-docs/swanky/issues) and we'll do our best to help you with it. ``` npm install swanky --save-dev ``` ## Documentation View the full user guide documentation [here](https://guide.swanky-docs.org/). ## Changelog Details changes for each release are documented in the [release notes](https://github.com/swanky-docs/swanky/releases). ## Contributing Please make sure to read the [Contributing Guide](https://github.com/swanky-docs/swanky/blob/master/CONTRIBUTING.md) before making a pull request. ## License This software is licensed under the MIT Licence. See [LICENSE](LICENSE). Copyright (c) 2017 Rod Leviton