Skip to main content

Microdata semantic markups support for Pelican Blog Generator

Project description

Microdata plugin for Pelican

Microdata semantic markups support for Pelican static blog generator.


Install the plugin via pip:

~$ pip install pelican-microdata


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


Once loaded you have access to microdata rst 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/>`


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


If not set, <> is the default value.


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:` <url:>`
    I live in Albuquerque, NM and work as an :itemprop:`engineer <title>`
    at :itemprop:`ACME Corp <affiliation>`.

will result in:

<p itemscope itemtype="">
    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="" itemprop="url"></a>
    I live in Albuquerque, NM and work as an <span itemprop="title">engineer</span>
    at <span itemprop="affiliation">ACME Corp</span>.


0.3.0 (2017-02-02)

  • Support for Pelican 2.7 and Python 3.3+
  • Drop support for Python 3.2
  • Use as default vocabulary prefix
  • Make vocabulary prefix configurable with MICRODATA_VOCABULARY

0.2 (2013-06-21)

  • Start working on Python 3 compatibility
  • Added compact option to ItemScope block
  • Consider nested <p> tags as compact

0.1 (2013-03-25)

  • Initial implementation

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page