The core engine for the Swanky Docs ecosystem.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
img
src
.editorconfig
.eslintignore
.gitignore
.nvmrc
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
appveyor.yml
package.json
yarn.lock

README.md

Swanky Docs Logo

A simple, flexible and powerful ecosystem for creating beautiful documentation.

NPM Version Build Status Project Badge semantic-release Commitizen friendly codecov.io License: 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.

Why Swanky Docs?

Unlike many other documentation tools that are focused on building documentation from one type of source e.g. JSDocs, Markdown, Swagger 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 tool. If you encounter any problems, please submit a GitHub issue and we'll do our best to help you with it.

npm install swanky --save-dev

Documentation

View the full user guide documentation here.

Changelog

Details changes for each release are documented in the release notes.

Contributing

Please make sure to read the Contributing Guide before making a pull request.

License

This software is licensed under the MIT Licence. See LICENSE.

Copyright (c) 2017 Rod Leviton