Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Shopify/shopify-css-import
Add CSS import functionality to Shopify theme development with Grunt.js or Gulp.js
https://github.com/Shopify/shopify-css-import
Last synced: about 1 month ago
JSON representation
Add CSS import functionality to Shopify theme development with Grunt.js or Gulp.js
- Host: GitHub
- URL: https://github.com/Shopify/shopify-css-import
- Owner: Shopify
- License: mit
- Created: 2014-05-08T19:07:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T07:26:48.000Z (over 1 year ago)
- Last Synced: 2024-08-01T16:51:24.802Z (4 months ago)
- Language: Liquid
- Homepage: http://shopify.github.io/shopify-css-import
- Size: 95.7 KB
- Stars: 83
- Watchers: 474
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shopify - shopify-css-import - Add CSS import functionality to Shopify theme development with Grunt.js or Gulp.js. ⚠️ (Front-end Development / Others)
README
## Deprecation warning ⚠️
Instead of these one-off grunt/gulp build tasks, developers are encouraged to check out [Slate](https://github.com/Shopify/slate) -
a theme scaffolding and command line tool built for developing Shopify themes.
You can continue to use these tasks; however, this repo will not be kept up-to-date with changes in Shopify theme development.
---
Adding CSS @import to theme development
=====================
This guide will allow you to define your own folder structure for your stylesheets while building Shopify themes.
Stylesheets can be created and maintained in `css/` from your theme's root folder.
In the example `css/` folder there is a single `theme.scss.liquid` file that imports other stylesheets into it. Files starting with an underscore are not added to your `assets/` folder.
You can use Grunt or Gulp to achieve the same effect.
The theme files included in this repo are just for the example. Find the [latest version of Timber here](https://github.com/Shopify/timber).
### Requirements
- Ruby 1.9+
- Node.js 0.10.22+ ([check and upgrade Node.js here](http://stackoverflow.com/questions/20887400/gruntjs-bus-error-grunt-watch))
- [Shopify Theme Gem](https://github.com/Shopify/shopify_theme)
### Basic theme structure
```
├── assets/
├── layout/
├── snippets/
├── templates/
│
├── // Non-theme files/folders (Theme Gem, Grunt, Gulp, etc.)
├── config.yml
├── css/
├── Gemfile
├── Gruntfile.js
├── package.json
├── gulpfile.js
└── node_modules/
```
Grunt.js
=====================
Navigate to your theme root in Terminal.
##### 1. Install grunt globally
```
npm install -g grunt-cli
```
You may have to use `sudo` for this.
##### 2. Move Gemfile, Gruntfile.js and package.json to your theme's root
##### 3. Install gulp (globally) and gulp-cssimport
We specifically want the Gulp plugin so we have to install Gulp. Everything after this will be handled with Grunt.
```
npm install -g gulp
npm install gulp-cssimport
```
You may have to use `sudo` for this.
##### 4. Install required packages
```
npm install
```
##### 5. Run bundle install
```
bundle install
```
##### 6. Run grunt
```
grunt
```
That's it. Gruntfile.js will run both `theme watch` to upload new theme files to your store and `grunt gulp` to concatenate the stylesheets in `/css` at the same time.
Gulp.js
=====================
Navigate to your theme root in Terminal.
##### 1. Install gulp globally
```
npm install -g gulp
```
You may have to use `sudo` for this.
##### 2. Move gulpfile.js file in your theme's root
##### 3. Install required packages
```
npm install gulp-cssimport
```
##### 4. Run gulp watch
```
gulp watch
```
##### 5. Run Shopify theme gem
Make sure `config.yml` file is setup properly. [Docs here](https://github.com/Shopify/shopify_theme).
In a separate Terminal window that is still in your theme's root, run:
```
theme watch
```
Output
=====================
Once gulp or grunt runs it will create `theme.scss.liquid` inside your `/assets/` folder. To call this file you need to place `{{ 'theme.scss.css' | asset_url | stylesheet_tag }}` inside your `theme.liquid` file. Shopify automatically compiles everything on their servers. If for some reason it is not compiling it's probable because there is a random charset somewhere inside your stylesheet.