Metadata-Version: 2.1
Name: django-octicons
Version: 1.0.2
Summary: Django templatetags for GitHub's Octicons.
Home-page: https://github.com/sanketsaurav/django-octicons
Author: Sanket Saurav
Author-email: sanketsaurav@gmail.com
License: MIT
Description: 
        # django-octicons
        
        [![Build Status](https://travis-ci.org/sanketsaurav/django-octicons.svg?branch=master)](https://travis-ci.org/sanketsaurav/django-octicons)
        
        Template tags for Django to use [GitHub Octicons](https://octicons.github.com/).
        
        ## Installation
        
        Grab it from PyPI using pipenv (or pip):
        
        ```sh
        $ pipenv install django-octicons
        ```
        
        Install the app in your project:
        
        ```python
        # settings.py
        
        INSTALLED_APPS = [
            # other apps
            'octicons',
        ]
        ```
        
        ## Usage
        
        Load the tag library in your HTML template:
        
        ```html
        {% load octicons %}
        ```
        
        And then, you can use the icons like this:
        
        ```html
        <a class="btn btn-sm" href="#url" role="button">
          {% octicon "eye" %}
          Watch
        </a>
        ```
        
        You can also pass any required attributes:
        
        ```html
        <a class="btn btn-sm" href="#url" role="button">
          {% octicon "thumbsup" height="60" class="large" %}
          Confirm Purchase
        </a>
        ```
        
        All attributes passed will be added as HTML attributes to the SVG element
        of the icon.
        
        ### Styling
        
        You should add the following in your styles:
        
        ```css
        .octicon {
          display: inline-block;
          vertical-align: text-top;
          fill: currentColor;
        }
        ```
        
        The class `octicon` will be present in all icons. You are free to style it however you want.
        
Keywords: django icons github octicons templatetags
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Environment :: Web Environment
Classifier: Topic :: Internet
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Requires-Python: >=2.7.0
Description-Content-Type: text/markdown
