Metadata-Version: 2.0
Name: pelican-fontawesome
Version: 0.1.0
Summary: Easily embed FontAwesome icons in your RST
Home-page: https://github.com/kura/pelican-fontawesome
Author: Kura
Author-email: kura@kura.io
License: MIT
Download-URL: https://github.com/kura/pelican-fontawesome/archive/0.1.0.zip
Platform: linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing

===================
Pelican FontAwesome
===================

Pelican FontAwesome allows you to embed FontAwesome icons in your RST documents.

Installation
============

To install pelican-fontawesome, simply install it from PyPI:

.. code-block:: bash

    $ pip install pelican-fontawesome

Then enabled it in your pelicanconf.py

.. code-block:: python

    PLUGINS = [
        # ...
        'pelican_fontawesome',
        # ...
    ]

Include the FontAwesome CSS in your base template.

.. code-block:: html

    <link href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">

Usage
=====

In your article or page, you simply need to add a line to embed you video.

.. code-block:: rst

    :fa:`fa-github`

Which will result in:

.. code-block:: html

    <span class="fa fa-github"></span>

License
=======

`MIT`_ license.

.. _MIT: http://opensource.org/licenses/MIT

