generator-silverstripe-theme

A yeoman generator for a Silverstripe theme.

Caution: its WIP atm

Features

• Bower, Grunt integration via yeoman
• Ribs Skeleton fork, Scss framework
• Foundation
• compass
• jshint
• modernizr custom builds
• ftpush

##Installation todo

Getting Started

Go to the root folder of your Silverstripe install and run:

yo silverstripe-theme

Then go to your created theme under

cd themes/<your-theme-name>

and there you can run grunt or bower for this theme.

By calling Grunt from within the theme folder you can run multiple themes under yeoman.

###Tasks

The default grunt task is watch which will run compass watch.

Disclaimer

I dont use Javascript minify tasks here. I rely on the provided Silverstripe Minifier mechanims. So you best define your javascript in your PageController, using the Requirements. So you can benefit from SilverStripe Requirements mechanism, especially when using modules.

public function init()
    {
        parent::init();
        $themeFolder = $this->ThemeDir();
        Requirements::combine_files(
                            'scripts.js', array(
                                            $themeFolder . '/javascripts/modernizr.js',
                                            $themeFolder . '/bower_components/jquery/dist/jquery.min.js',
                                            $themeFolder . '/javascripts/main.js'
                                        )
                );
    }

If you choose to use Foundation add this also:

$themeFolder . '/bower_components/foundation/js/foundation.js',

For Css i let Compass do the work.

I also left out image optimizers, as they often dont work :/

If you use git dont forget to edit your .gitignore and add folder like bower_components, .sass-cache, node_modules (this is actually a task for this generator ;))

Todo

• tests
• custom theme dir, f.e if you use app with templates integrated
• gitignore handling as the git ognore is not part of the dir but of parent SS installation
• Bootstrap sass theme
• ftpush server inquiry
• ftpush credential inquiry
• ftpush credential file to gitignore
• ftpush for app(mysite) & theme
• responsive_images for assets
• copy dist
• responsiveNavigation.ss
• css&js strategy: use SilverStripe buildIn, minimizer
• js strategy remove

License

MIT License