swanky-server v3.0.2
Swanky
A simple, flexible and powerful tool for creating beautiful documentation.
Install
npm install swanky --save-dev
Directory Structure
Code is organised into modules which contain one-or-more components. This a great way to ensure maintainable code by encapsulation of behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
swanky/
├──config/ * configuration files live here (e.g. grunt, webpack, verify, testUnit)
│
├──src/ * source code files should be here
│
├──build/ * production-build code should live here
│
├──reports/ * test reports appear here
│
├──test/ * unit test specifications live here
│
├──confit.json * The project config file generated by 'yo confit'
├──CONTRIBUTING.md * how to contribute to the repo
├──README.md * this file
└──package.json * what NPM uses to manage it's dependencies
Usage
Swanky can be installed independently or configured for you using the swanky-cli tool.
Contributing
See CONTRIBUTING.md.
License
This software is licensed under the MIT Licence. See LICENSE.
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago