Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.
/ lemonleaf Public archive

A quickstart environment for LemonStand theme development

License

Notifications You must be signed in to change notification settings

jimhill/lemonleaf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LemonLeaf logo

LemonLeaf

This package is designed as a quickstart environment for producing themes for LemonStand.

Getting started

Step 1: Install gulp (assuming you already have nodejs installed):

$ npm i gulp

Step 2: Install gulp dependencies:

$ npm i -D gulp-util gulp-changed gulp-rimraf gulp-notify gulp-less [email protected] gulp-jshint gulp-concat gulp-uglify gulp-rename gulp-zip

Step 3: Start watching your files (the default gulp task - see details below):

$ gulp

Step 4: Create your theme as normal in the src directory - not forgetting to update the README.md and theme.yaml files.

Step 5: When ready you can then either upload your theme files using the LemonStand backend interface (you can use the handy $ gulp zip task to create a zipped version of your theme. Or you use LemonSync (there is an included boilerplate lemonsync.cfg file).

Configuring

You can manipulate the gulpfile.js file to suit your needs. Everything in there is simply a default.

Gulp tasks

default

$ gulp

By default this simply calls the watch task.


watch

$ gulp watch

This default action watches changes in files within the src directory and runs the min-styles and/or the min-scripts tasks.


flush

$ gulp flush

This removes all distribution files from the appropriate dist directories. Useful when you want to remove old files prior to a new build.


min-styles

$ gulp min-styles

This triggers min-styles-less by default. You can configure this to suit your needs. You will see that min-styles-sass is available simply by uncommenting.


min-styles-less

$ gulp min-styles-less

Compiles and compresses the less files found in src/less/ and contatenates them into dist/theme/css/main.css.


min-styles-sass

$ gulp min-styles-sass

Compiles and compresses the Sass files found in src/scss/ and contatenates them into dist/theme/css/main.css. Listens for file .scss file extensions by default.


min-scripts

$ gulp min-scripts

This triggers min-scripts-js by default. You can configure this to suit your needs.


min-scripts-js

$ gulp min-scripts-js

Compiles and compresses the JavaScript files found in src/js/ and contatenates them into dist/theme/js/main.min.js.


min-vendor-scripts-js

$ gulp min-vendor-scripts-js

Compiles and compresses any 3rd party vendor JavaScript files found in src/js/vendors/ and contatenates them into dist/theme/js/vendors.min.js.


resources

$ gulp resources

This moves all resources into the dist directory.


twig

$ gulp twig

This moves all twig files into the dist directory.


build

$ gulp build

When you want to compile everything into the dist folder, including fonts, images etc use this.


zip

$ gulp zip

This task simply creates dist/theme.zip containing the contents of the dist/theme directory. This can then be uploaded via the LemonStand backend interface.


Support

This is not an officially supported repository and has been prepared by me to simply make life a little easier. I may or may not have time to fix issues, but please do fork/hack/whatever with it. Maybe someone with time could spin a Grunt version?

License

Feel free to use this however you wish. Code released under the MIT license.

About

A quickstart environment for LemonStand theme development

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published