Skip to content

Commit

Permalink
modified readme to be more relatable to openbridge
Browse files Browse the repository at this point in the history
  • Loading branch information
thenetimp authored Oct 15, 2018
1 parent 7968a47 commit 4083fd3
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
flask-sass
==========

**This project is not maintained and abandoned. Feel free to fork.**

A small Flask extension that makes it easy to use Sass (SCSS) with your Flask application.

Why another one? Because [Flask-Scss](https://bitbucket.org/bcarlin/flask-scss) doesn't
compile ``@import``ed files, and I liked the simple way [flask-coffee2js](https://github.com/weapp/flask-coffee2js)
compiled CoffeeScript files.
This was forked as we use it in our projects and wanted to make sure a copy was available if the [original](https://github.com/imiric/flask-sass) was ever removed.


Code unabashedly adapted from https://github.com/weapp/flask-coffee2js.
The original creator adapted from https://github.com/weapp/flask-coffee2js to perform the same task for sass


## Installation

### Install with PIP

pip install git+https://github.com/imiric/flask-sass.git#egg=flask-sass
pip install git+https://github.com/openbridge/flask-sass.git#egg=flask-sass


## Usage

You can activate it by calling the ``sass`` function with your Flask app as a parameter:
Your output dir should be located in the static directory.

from flaskext.sass import sass
sass(app, input_dir='assets/scss', output_dir='static/css')
sass(app, input_dir='assets/scss', output_dir='css')

This will intercept the request for ``output_dir/*.css`` and compile the file if it is
necesary using the files from ``input_dir/*.scss``.
Expand Down

0 comments on commit 4083fd3

Please sign in to comment.