generator-style-guider
v0.3.0
Published
Generate digital style guides for your organisation or project with a re-usable css and js framework
Downloads
3
Maintainers
Readme
Style Guider
Generate a re-usable web framework, with a digital style guide, for your organisation or project
Demo
View a demo style guide built with Style Guider, and its source code
Features
- Build a CSS, Javascript and Pug framework to be re-used across multiple projects.
- Generate a Style Guide / Documentation for your framework, with live interactive previews of each component.
- Built-in linting
- Use NPM or Yarn to manage dependencies.
Coming soon
- Bootstrap, Foundation or VanillaCSS options (currently foundation is default)
- JS framework options
- HTMl template language options (Pug, Handlebars, EJS etc)
Installation
First, install Yeoman and generator-style-guider using npm (we assume you have pre-installed node.js).
npm install -g yo
npm install -g generator-style-guider
Then generate your new project:
yo style-guider
Adding components
Add new components for your style guide:
yo style-guider:component
License
MIT © Ian Egner