framework-generator

A quick and dirty front-end framework/styleguide generator.

Getting Started

Requirements: npm, gulp-cli

Setup: npm install
Development: npm start
Production: npm run build

Documentation

Data

Add your own variables/functions to ./src/_includes/app-functions.php
Use them in Pages or Pattern files, ex: <?php echo $your-variable; ?>

Pages

Create new pages in ./src/
Update the app menu in ./src/_includes/app-menu.php

Patterns

Create new patterns in ./src/_patterns/
Use snippet within pages, ex: <?php require '_patterns/your-pattern.php' ?>

Styles

Create SCSS files in ./src/sass/

Scripts

Create Javascript files in ./src/js/