Skip to content

Latest commit

 

History

History
80 lines (67 loc) · 1.99 KB

README.md

File metadata and controls

80 lines (67 loc) · 1.99 KB
Raw

Build Status

Kashmir

A theme with modern tooling.

Kashmir Screenshot

Setup

  • Node
  • Gulp 
    $ npm install -g gulp
  • Composer 
    php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"
mv composer.phar /usr/local/bin/composer
  • Drupal Modules
    • Components
      • composer require drupal/components
      • drush dl components
    • Twig Tweak (Optional)
      • composer require drupal/twig_tweak
      • drush dl twig_tweak

Setup sub-theme

  • Install Kashmir

    • git clone https://github.com/skippednote/kashmir.git subthemeName
    • Rename reference to kashmir to subthemeName

  • Enable theme

    • drush en subthemeName

  • Configure settings

    • Update settings in gulp-tasks/_config.js for Browsersync and Source for scripts and styles.

Usage

  • Dev Environment
    • Build assets by running: gulp.
    • Watch for changes using: gulp watch.
  • Prod/Test Environment
    • Build assets by running: gulp --type production.

Theme tasks

  • Styles
    • gulp styles
    • To Compile styles and generate RTL styles for files with .ltr suffix.
  • Styles Lint
    • gulp scripts:lint
    • To check styles for errors and warnings.
  • Scripts
    • gulp scripts
    • To Compile and Uglify scripts
  • Scripts Lint
    • gulp scripts:lint
    • To check scripts for errors and warnings.
  • Global Lint
    • gulp lint
    • To check styles and scripts for errors and warnings.
  • SVG
    • gulp svg
    • To combine multiple SVG files into a single sprite.
  • Watch
    • gulp watch
    • Starts a proxy server and, lints and compiles file on change.
  • Default
    • gulp
    • To generate SVG sprite and lint + compile the scripts and styles in theme.