Skip to content

Commit

Permalink
Updated README.rst syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinetienne committed Nov 19, 2013
1 parent f065f92 commit 90a726a
Showing 1 changed file with 36 additions and 16 deletions.
52 changes: 36 additions & 16 deletions README.rst
@@ -1,17 +1,30 @@
# django-bootstrap-sass
---------------------
django-bootstrap-sass
---------------------

django-bootstrap-sass uses jlong/sass-twitter-bootstrap to allow more

.. image:: https://pypip.in/v/django-bootstrap-sass/badge.png
:target: https://pypi.python.org/pypi/django-bootstrap-sass

.. image:: https://pypip.in/d/django-bootstrap-sass/badge.png
:target: https://pypi.python.org/pypi/django-bootstrap-sass


django-bootstrap-sass uses jlong/sass-twitter-bootstrap_ to allow more
control over bootstrap stylesheets by using scss features.

Note:
You'll need to install a sass preprocessor such as django-compressor to be able
to include sass file into your django project and a tool to collect your static files such as django-supervisor or watchdog.
You'll need to install a sass preprocessor such as django-compressor_ to be able
to include sass_ file into your django project and a tool to collect your static
files such as django-supervisor_ or watchdog_.

## Install
Install
-------

pip install django-bootstrap-sass

## Setup
Setup
-----

Django settings.py

Expand All @@ -21,27 +34,34 @@ Django settings.py
'bootstrap_sass',
)

## Usage
Usage
-----

To include sass file

<link rel="text/x-scss" href="{{ STATIC_URL }}stylesheets/bootstrap.scss" type="text/css" charset="utf-8">

To include javascripts file:

<script src="{{ STATIC_URL }}stylesheets/bootstrap-{{ module }}.js"></script>
<script src="{{ STATIC_URL }}javascripts/{{ module }}.js"></script>

Where `{{ module }}` is one of bootstrap module (`tab`, `affix`..)

Where {{ module }} is one of bootstrap module (tab, affix..)
Integration example
-------------------

## Integration example
* sass_
* django-contrib-static_
* django-compressor_
* django-supervisor_

Here is a little setup to get started with django-bootstrap-sass. The following
assume you'll be using the following tools:

- [sass](http://sass-lang.com/download.html)
- [django-contrib-static-files](https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/)
- [django-compressor](https://github.com/jezdez/django_compressor)
- [django-supervisor](https://github.com/rfk/django-supervisor)
.. _sass: http://sass-lang.com/download.html
.. _django-contrib-static-files: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/
.. _django-compressor: https://github.com/jezdez/django_compressor
.. _django-supervisor: https://github.com/rfk/django-supervisor
.. _watchdog: https://github.com/gorakhargosh/watchdog
.. _jlong/sass-twitter-bootstrap: https://github.com/jlong/sass-twitter-bootstrap



0 comments on commit 90a726a

Please sign in to comment.