diff options
| author | Justin Mayer <entroP@gmail.com> | 2019-09-21 12:19:43 -0700 |
|---|---|---|
| committer | Justin Mayer <entroP@gmail.com> | 2019-10-16 15:29:03 -0700 |
| commit | bcac6e80b9e22cf6140e6ceba6fe1f977832c5b9 (patch) | |
| tree | 88b108c13a6eb917bc0313d05b37e92fc6e1916f /docs | |
| parent | 643bccc497183d9cc2d7c80423fbd8e088dd3dad (diff) | |
| download | pelican-bcac6e80b9e22cf6140e6ceba6fe1f977832c5b9.tar.gz | |
Improve content metadata field docs. Fixes #2347
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content.rst | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/docs/content.rst b/docs/content.rst index f0022c35..bff30e1d 100644 --- a/docs/content.rst +++ b/docs/content.rst @@ -71,22 +71,31 @@ Metadata syntax for Markdown posts should follow this pattern:: This is the content of my super blog post. You can also have your own metadata keys (so long as they don't conflict with -reserved metadata keywords) for use in your python templates. The following is +reserved metadata keywords) for use in your templates. Following is the list of reserved metadata keywords: -* `Title` -* `Tags` -* `Date` -* `Modified` -* `Status` -* `Category` -* `Author` -* `Authors` -* `Slug` -* `Summary` -* `Template` -* `Save_as` -* `Url` +================= ================ ============================================ +reStructuredText Markdown Description +================= ================ ============================================ +``:title:`` ``Title:`` Title of the article or page +``:date:`` ``Date:`` Publication date (``YYYY-MM-DD HH:SS``) +``:modified:`` ``Modified:`` Modification date (``YYYY-MM-DD HH:SS``) +``:tags:`` ``Tags:`` Content tags, separated by commas +``:keywords:`` ``Keywords:`` Content keywords, separated by commas +``:category:`` ``Category:`` Content category (one only — not multiple) +``:slug:`` ``Slug:`` Identifier used in URLs and translations +``:author:`` ``Author:`` Content author, when there is only one +``:authors:`` ``Authors:`` Content authors, when there are multiple +``:summary:`` ``Summary:`` Brief description of content for index pages +``:lang:`` ``Lang:`` Content language ID (``en``, ``fr``, etc.) +``:translation:`` ``Translation:`` Is article is a translation of another + (``true`` or ``false``) +``:status:`` ``Status:`` Content status: + ``draft``, ``hidden``, or ``published`` +``:template:`` ``Template:`` Name of template to use to generate content +``:save_us:`` ``Save_us:`` Save content to this relative file path +``:url:`` ``Url:`` URL to use for this article/page +================= ================ ============================================ Readers for additional formats (such as AsciiDoc_) are available via plugins. Refer to `pelican-plugins`_ repository for those. |