From fa3577db758864585fdf9bd3b55072206bf162d3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 11 Dec 2017 00:40:54 +0100 Subject: [PATCH] doc: mention that the :description: field should be formatted. --- doc/pelican/theme.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/pelican/theme.rst b/doc/pelican/theme.rst index 622449fb..ab6be0a2 100644 --- a/doc/pelican/theme.rst +++ b/doc/pelican/theme.rst @@ -371,9 +371,17 @@ above: You can use :rst:`:description:` field to populate :html:``, which can be then shown in search engine results. Other than that, the field -does not appear anywhere on the rendered page. For sharing pages on Twitter, -Facebook and elsewhere, both `Open Graph `_ and -`Twitter Card `_ +does not appear anywhere on the rendered page. It's recommended to add it to +:py:`FORMATTED_FIELDS` so you can make use of the +`advanced typography features <{filename}/plugins/htmlsanity.rst#typography>`_ +like smart quotes etc. in it: + +.. code:: py + + FORMATTED_FIELDS += ['description'] + +For sharing pages on Twitter, Facebook and elsewhere, both `Open Graph `_ +and `Twitter Card `_ :html:`` tags are supported: - Page title is mapped to ``og:title`` / ``twitter:title`` -- 2.30.2