Basic Usage
===========
Installation
------------
Using PYPI
.. code:: bash
$ pip install flask-rings
or using git:
.. code:: bash
$ pip install git+https://github.com/z-t-y/flask-rings.git
Initialization
--------------
.. code:: python
from flask import Flask
from flask_rings import Rings
app = Flask(__name__)
rings = Rings(app)
or
.. code:: python
from flask import Flask
from flask_rings import Rings
rings = Rings()
def create_app():
app = Flask(__name__)
rings.init_app(app)
Resource loader
---------------
Flask-Rings a helper for loading the CSS of Rings.
Call it in your base template, for example:
.. code:: jinja
...
{{ rings.load() }}
Sample Template
---------------
Unlike flask-bootstrap, flask-rings doesn't have a ``base.html`` built-in.
If you want a ``base.html``, here's an example:
.. code:: jinja
{% block head %}
{% block styles %}
{{ rings.load() }}
{% endblock %}
{% block title %}Your page title{% endblock %}
{% endblock %}
{% block content %}{% endblock %}
Using custom CDN
----------------
You can configure custom CDN by passing arguments to ``rings.load()``
For example:
.. code:: jinja
{{ rings.load(css_url="https://raw.sevencdn.com/rice0208/Rings/master/rings.min.css") }}
Using local resources
---------------------
You can set the ``RINGS_SERVE_LOCAL`` to ``True`` to use the resources provided by Flask-Rings.
Note that ``RINGS_SERVE_LOCAL`` defaults to ``True`` if you have the flask debugger on.