Metadata-Version: 1.1
Name: embedly-cards
Version: 0.2.0
Summary: Pelican plugin for embedding external content using Embed.ly Cards
Home-page: https://github.com/josh146/embedly_cards
Author: Josh Izaac
Author-email: josh@iza.ac
License: GPLv3
Download-URL: https://github.com/josh146/embedly_cards/archive/0.2.0.zip
Description: Embedly-Cards
        ===============
        
        Embedly-cards is a Pelican_ plugin providing restucturedText directives to allow
        easy embedding of external content using `Embed.ly Cards <http://embed.ly/cards>`_.
        
        `ReST <http://iza.ac/posts/2014/03/embedly-cards/>`_ and
        `markdown <http://iza.ac/posts/2014/04/embedly-cards-v02-markdown-support/>`_
        live examples can also be viewed from a Pelican-built website.
        
        .. _Pelican: http://getpelican.com
        
        
        Features
        ============
        Embed content within a page or blog post easily, simply by specifying the URL of
        the target page. Content is automatically recognised, extracted, and formatted as
        a 'card'; this may contain a short article preview, embedded video, picture etc.
        
        To preview a card, they can be generated online using `Embed.ly <http://embed.ly/cards>`_.
        Almost any site is compatible, including YouTube, Flickr, Google+, Maps, Wordpress etc.
        
        Installation
        ============
        Embedly-cards can be installed using `pip`
        
        .. code-block:: bash
            
            $ pip install embedly-cards
        
        or manually from the source code
        
        .. code-block:: bash
        
            $ python setup.py install
        
        Once installed, simply add it to your ``pelicanconf.py`` configuration file:
        
        .. code-block:: python
        
            PLUGINS = [
                # ...
                'embedly_cards'
            ]
        
        If you are planning on embedding content in markdown ``.md`` files,
        you must also add it to the ``MD_EXTENSIONS`` options, like so:
        
        .. code-block:: python
        
            from embedly_cards import EmbedlyCardExtension
            MD_EXTENSIONS = ['codehilite(css_class=highlight)',
                             'extra',
                             # ...
                             EmbedlyCardExtension()]
        
        .. important::
            If creating the ``MD_EXTENSIONS`` variable for the first time,
            ensure that the Pelican ``'codehilite(css_class=highlight)'``
            and ``'extra'`` markdown extensions are included in the list.
        
        Usage
        ============
        
        For example, to embed a YouTube video in ReStructuredText:
        
        .. code-block:: ReST
        
            .. embedly-card:: https://www.youtube.com/watch?v=ZlfIVEy_YOA
        
        or in markdown:
        
        .. code-block::
        
            [!embedlycard](https://www.youtube.com/watch?v=ZlfIVEy_YOA)
        
        Or to embed an article/webpage in ReStructuredText:
        
        .. code-block:: ReST
            
            .. embedly-card:: http://physics.stackexchange.com/questions/5265/cooling-a-cup-of-coffee-with-help-of-a-spoon
            
        or in markdown:
        
        .. code-block::
        
            [!embedlycard](http://physics.stackexchange.com/questions/5265/cooling-a-cup-of-coffee-with-help-of-a-spoon)
        
        Options
        ========
        
        The ``card-chrome`` (ReST) or ``chrome`` (markdown) option, if provided, specifies
        whether or not to preserve the border around the card. By default, the border
        will be removed automatically *if Embed.ly supports it*; however to force the
        border to remain, you may pass ``:card-chrome: 1`` (ReST),
        
        .. code-block:: ReST
        
            .. embedly-card:: https://www.youtube.com/watch?v=ZlfIVEy_YOA
                :card-chrome: 1
        
        or ``chrome=1`` (markdown):
        
        .. code-block::
        
            [!embedlycard?chrome=1](https://www.youtube.com/watch?v=ZlfIVEy_YOA)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Provides: embedly_cards
