chiark / gitweb /
doc: mention that the :description: field should be formatted.
authorVladimír Vondruš <mosra@centrum.cz>
Sun, 10 Dec 2017 23:40:54 +0000 (00:40 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Mon, 11 Dec 2017 01:48:25 +0000 (02:48 +0100)
doc/pelican/theme.rst

index 622449fb16fdc90279de18ec7c1d9541ea2ae826..ab6be0a2108452c306c20329c7d5a4f61575312d 100644 (file)
@@ -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``