maedahbatool / mimogear

Mimogear: a simple static site generator and web development boilerplate

Mimogear

Mimogear is a complete web development boilerplate for developing static sites. Packed inside Mimogear you'll find Gulp, Sass, and Pug boilerplates to get you started. Newcomers and professionals alike will feel right at home with a solid start for any static site! Just run gulp and get buildin!

Highlights

Feature	Summary
Gulp Boilerplate	Gulp intelligently handles compilation and optimization tasks based on the environment for speedier Sass, Pug, and js development.
Responsive Sass Boilerplate	A flexible Sass boilerplate with various mixins, a simpler form of BEM, and a platform agnostic approach.
Base Pug Template Boilerplate	Generate HTML files faster with Pug's condensed syntax, a highly structured HTML template setup, markdown support, and starter partials.
Optional Javascript Modules	Completely optional javascript modules to create slideshows, lightboxes, triggers, and elements on the fly.
Performance Optimizations	Gulp will minify CSS, concatenate & uglify javascript, and optimize images to produce performant static pages.
Live Reloading	Reloads the browser whenever you make a change to a file.
Cross-device Synchronization	BrowserSync synchronizes actions across devices for quicker testing.
Style Guide Generator	A page for core HTML elements is created by default for easier site styling and future referencing.
Deployments Starter Kit	Deploy your site with boilerplates for github pages, and surge with a Travis CI starter kit.

Getting Started

Once you're ready and setup with npm, whip out your terminal and enter in the following goodies:

git clone https://github.com/mimoduo/mimogear.git
cd mimogear
npm install gulp-cli -g
npm install
gulp

Your site will open up in a browser window automatically, gulp will begin watching your files, and browserSync will automatically reload your changes. Now you're ready to get started in developing html:pug, css:sass, and javascript. Check out /src/ to see your shiny new web development boilerplate!

Once you're all set, there's documentation ready for ya:

• Quickstart Guide
• Deployment
• Gulp
• Javascript
• CSS:Sass
• HTML:Pug

Share Your Sites Using Mimogear

If you have built a site with Mimogear and you wanna show the world your sweet site, feel free to create a pull request and add it to the list below:

• mimogear
• Your Site!

Thank You, Everyone!

I hope you enjoy developing with Mimogear as much as I have enjoyed building it! Please share it if you love it! This static site generator wouldn't be possible without all the help of my friends. They've contributed to every single aspect of this without knowing it ^w^ Most notably Nick Hall for being the best mentor in the world!