Skip to content

atsphinx/og-article

Repository files navigation

atsphinx-og-article

Stable version on PyPI "Continuous Integration" status for main branch Documentation status

Support article tpye's properties of Open Graph for Sphinx.

Overview

This is Sphinx extension to handle properties of article typeof Open Graph.

You can add og-article directive with some options.

.. og-article::
   :published_time: 2023-05-07
   :modified_time: 2023-05-07 12:00:00

When it runs builder with this directive, your html file is generated included <meta property="article:published_time"> and more properties.

Getting started

Install from PyPI.

Configure your conf.py.

Append og-article directive into your document.

Important note

This extension renders only article:* properties, and does not render og:* properties.

I recommend to install sphinxext-opengraph too.

Ref