summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGio <sethg@ipi.org>2021-04-16 19:07:35 -0500
committerJustin Mayer <entroP@gmail.com>2021-05-04 13:54:32 -0500
commitadd3628a6474f2bd145fe2ea55c5e5255e9970ba (patch)
tree9e8452bf1769550e30173268a4f0e9e8804b0177 /docs
parent487da3550bffb96ebfed9dbf206d8b3574886a21 (diff)
downloadpelican-add3628a6474f2bd145fe2ea55c5e5255e9970ba.tar.gz
Add support for hidden articles
Diffstat (limited to 'docs')
-rw-r--r--docs/content.rst8
-rw-r--r--docs/themes.rst7
2 files changed, 12 insertions, 3 deletions
diff --git a/docs/content.rst b/docs/content.rst
index 48c851ab..cd492012 100644
--- a/docs/content.rst
+++ b/docs/content.rst
@@ -614,6 +614,14 @@ the ``DEFAULT_METADATA``::
To publish a post when the default status is ``draft``, update the post's
metadata to include ``Status: published``.
+Hidden Posts
+============
+
+Like pages, posts can also be marked as ``hidden`` with the ``Status: hidden``
+attribute. Hidden posts will be output to ``ARTICLE_SAVE_AS`` as expected, but
+are not included by default in tag or category indexes, nor in the main
+article feed. This has the effect of creating an "unlisted" post.
+
.. _W3C ISO 8601: https://www.w3.org/TR/NOTE-datetime
.. _AsciiDoc: https://www.methods.co.nz/asciidoc/
.. _pelican-plugins: https://github.com/getpelican/pelican-plugins
diff --git a/docs/themes.rst b/docs/themes.rst
index 0c053fce..c4d3ed7f 100644
--- a/docs/themes.rst
+++ b/docs/themes.rst
@@ -66,9 +66,9 @@ Common variables
All of these settings will be available to all templates.
-============= ===================================================
+=============== ===================================================
Variable Description
-============= ===================================================
+=============== ===================================================
output_file The name of the file currently being generated. For
instance, when Pelican is rendering the home page,
output_file will be "index.html".
@@ -80,6 +80,7 @@ articles The list of articles, ordered descending by date.
in the `all_articles` variable.
dates The same list of articles, but ordered by date,
ascending.
+hidden_articles The list of hidden articles
drafts The list of draft articles
authors A list of (author, articles) tuples, containing all
the authors and corresponding articles (values)
@@ -90,7 +91,7 @@ tags A list of (tag, articles) tuples, containing all
pages The list of pages
hidden_pages The list of hidden pages
draft_pages The list of draft pages
-============= ===================================================
+=============== ===================================================
Sorting