Giter Club home page Giter Club logo

magento2-sass-preprocessor's Introduction

Packagist Packagist Build Status Coverage Status

Magento 2 - Sass Preprocessor module

Module for Sass processing during static content deployment with additional Gulp workflow to improve Magento 2 development speed. It compiles SCSS using scssphp and process standard @import instruction as well as @magento_import.

Installation

  1. Install module via composer composer require clawrock/magento2-sass-preprocessor
  2. Register module php bin/magento setup:upgrade
  3. Compile Sass theme using php bin/magento setup:static-content:deploy -f

Compatibility

  • Magento 2.2 - 2.3
  • PHP 7.0 - 7.2
  • Gulp 3.9
  • Node.js v8 or later

Gulp workflow

  1. Install Node.js
  2. Install Gulp configuration php bin/magento dev:gulp:install
  3. Install Gulp and required dependencies npm install
  4. Define theme configuration php bin/magento dev:gulp:theme
  5. Symlink theme to pub/static folder gulp exec:[theme_key]
  6. Compile Scss gulp scss:[theme_key]
  7. Watch for changes gulp watch:[theme_key]

Browsersync

Pass --proxy http://magento.test argument to gulp watch or gulp watch:[theme_key] where http://magento.test is Magento base url and Browsersync will be automatically enabled.

Compatible themes

Troubleshooting

  • If you have previously installed Grunt, please make sure you have removed package-lock.json and node_modules folder. Then run npm install.

magento2-sass-preprocessor's People

Contributors

makao avatar

Watchers

Bahram Davoodi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.