From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 10 Dec 2017 23:40:54 +0000 (+0100)
Subject: doc: mention that the :description: field should be formatted.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=fa3577db758864585fdf9bd3b55072206bf162d3;p=blog.git

doc: mention that the :description: field should be formatted.
---

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:`<meta name="description">`,
 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 <http://ogp.me/>`_ and
-`Twitter Card <https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/summary-card-with-large-image>`_
+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 <http://ogp.me/>`_
+and `Twitter Card <https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/summary-card-with-large-image>`_
 :html:`<meta>` tags are supported:
 
 -   Page title is mapped to ``og:title`` / ``twitter:title``