mindgruve/style-guide

This is the custom style guide that Mindgruve can use in any project.

1.6.1 2016-03-21 20:26 UTC

Requires

• symfony/filesystem: ~2.6
• twig/twig: ~1.18

Requires (Dev)

• phpunit/phpunit: 4.0.*

proprietary

• Abishai Gray

README

This style guide template is meant to provide a boilerplate for for your living style guide needs.

Using a configuration file, you can quickly set up a style guide page with all the necessary markup to review a complete set of html elements. You can even use it for more complex markup like Bootstrap Components.

Get Started

To get started:

1. Run composer require mindgruve/style-guide in the application root.
2. Run vendor/bin/style-guide generate www/style-guide to install the basic style guide mini-site to www/style-guide and the config file to config/mgStyleGuide.ini.
3. Point the markupPath variable in the config to the location of the markup folder that you just generated in Step 2.
4. Add all the styles and javascript you use in your site to the mgStyleGuide.ini in the config directory.

Tips and Tricks

Now you can use the style guide for basic templating work. This is useful at the component and the page level.

Components can be added using the established patterns from the previous version of the style guide.

Page templates go in the markup directory you set in your config. Any requests for WEB_ROOT/home will load base.html.twig and include markup/home.html or markup/home.html.twig.