django-octicons-v10 1.0.4

Django templatetags for GitHub Octicons v10.0.0.

django-octicons-v10

Django templatetags for GitHub Octicons v10.0.0.

This library aims to provide a similar interface to the official (Jekyll, Ruby, etc.) octicon libraries provided by GitHub, but as Django templatetags.

django-octicons is a library that already does this, but currently for an older version of octicons.

Installation

Upgrade pip:

pip install --upgrade pip

Install the latest version:

pip install django-octicons-v10

Place octicons_v10 into your installed apps:

INSTALLED_APPS = [
    # blah, blah, other apps...
    "octicons_v10",
]

Usage

Load the octicons tag library in your Django template:

{% load octicons %}

Use template tags where you want to place an Octicon:

{% octicon "git-branch" %}

Classes

You can pass classes to your shiny new octicon:

<a class="btn">
    {% octicon "git-branch" class="text-purple" %}
    Branches
</a>

Note: The following classes are assigned to the octicon by default:

• octicon
• octicon-{ICON_NAME}, for example octicon-git-branch

Sizing

You can pass width or height or both for your desired size:

<a href="#" class="Header-link">
    {% octicon "mark-github" width="32" %}
    GitHub
</a>

If only width or height is passed, then the other scales accordingly.

Note: The default size is 16px by 16px.