Microdata semantic markups support for Pelican Blog Generator
Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
microdata
.editorconfig
.gitignore
.travis.yml
CHANGELOG.rst
LICENSE
MANIFEST.in
README.rst
bumpr.rc
coverage.rc
setup.cfg
setup.py
tox.ini

README.rst

Microdata plugin for Pelican

https://secure.travis-ci.org/noirbizarre/pelican-microdata.svg?branch=master https://coveralls.io/repos/noirbizarre/pelican-microdata/badge.svg?branch=master

Microdata semantic markups support for Pelican static blog generator.

Installation

Install the plugin via pip:

~$ pip install pelican-microdata

Usage

To load the plugin, you have to add it in your settings file.

PLUGINS = (
    'microdata',
)

Once loaded you have access to microdata rst directives.

Directives

Microdata plugin provides two directives:

  • itemscope, a block directive allowing to declare an itemscope block:

    .. itemscope:: <Schema type>
        :tag: element type (default: div)
        :itemprop: optionnal itemprop attribute
        :compact: optionnal
    
        Nested content
  • itemprop, an inline directive/role allowing to annotate some text with an itemprop attribute.

    :itemprop:`Displayed text <itemprop name>`
    :itemprop:`Displayed text <itemprop name:http://some.url/>`

Settings

You can define a vocabulary to use with the MICRODATA_VOCABULARY setting.

MICRODATA_VOCABULARY = 'http://data-vocabulary.org'

If not set, schema.org <http://schema.org> is the default value.

Example

This reStructuredText document:

.. itemscope:: Person
    :tag: p

    My name is :itemprop:`Bob Smith <name>`
    but people call me :itemprop:`Smithy <nickanme>`.
    Here is my home page:
    :itemprop:`www.exemple.com <url:http://www.example.com>`
    I live in Albuquerque, NM and work as an :itemprop:`engineer <title>`
    at :itemprop:`ACME Corp <affiliation>`.

will result in:

<p itemscope itemtype="http://schema.org/Person">
    My name is <span itemprop="name">Bob Smith</span>
    but people call me <span itemprop="nickname">Smithy</span>.
    Here is my home page:
    <a href="http://www.example.com" itemprop="url">www.example.com</a>
    I live in Albuquerque, NM and work as an <span itemprop="title">engineer</span>
    at <span itemprop="affiliation">ACME Corp</span>.
</p>