Main page | A Pelican Blog

From c0814fd985acc46c18974d1933514dc45a2208c4 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 17 Jan 2018 01:10:36 +0100 Subject: [PATCH] Ability to show list of latest news on the index page. --- css/m-components.css | 15 +++++++ doc/css/page-layout.rst | 41 ++++++++++++++++++ doc/pelican/theme.rst | 20 +++++++++ pelican-theme/templates/page.html | 14 +++++++ pelican-theme/test/__init__.py | 4 +- .../test/blog_news_on_index/article.rst | 4 ++ .../test/blog_news_on_index/article2.rst | 4 ++ .../test/blog_news_on_index/article3.rst | 4 ++ .../test/blog_news_on_index/index.html | 42 +++++++++++++++++++ .../test/blog_news_on_index/pages/index.rst | 5 +++ pelican-theme/test/test_blog.py | 12 ++++++ 11 files changed, 163 insertions(+), 2 deletions(-) create mode 100644 pelican-theme/test/blog_news_on_index/article.rst create mode 100644 pelican-theme/test/blog_news_on_index/article2.rst create mode 100644 pelican-theme/test/blog_news_on_index/article3.rst create mode 100644 pelican-theme/test/blog_news_on_index/index.html create mode 100644 pelican-theme/test/blog_news_on_index/pages/index.rst diff --git a/css/m-components.css b/css/m-components.css index 64cf7f47..76f605af 100644 --- a/css/m-components.css +++ b/css/m-components.css @@ -515,6 +515,21 @@ article#m-jumbo.m-inverted > header a:hover, article#m-jumbo.m-inverted > header color: #0f0f0f; } +/* News list on landing pages */ +.m-landing-news h3 a { + color: var(--color); + text-decoration: none; + text-transform: var(--nav-heading-case); +} +.m-landing-news h3 a:hover, .m-landing-news h3 a:hover, .m-landing-news h3 a:focus, .m-landing-news h3 a:active { + color: var(--article-heading-color); +} +.m-landing-news time { + display: inline-block; + margin-left: 1rem; + float: right; +} + /* Article pagination */ .m-article-pagination { text-align: center; diff --git a/doc/css/page-layout.rst b/doc/css/page-layout.rst index e8b84756..96817041 100644 --- a/doc/css/page-layout.rst +++ b/doc/css/page-layout.rst @@ -698,3 +698,44 @@ and save vertical space. For a tag cloud, mark the :html:`

` with + +`News list on index page`_ +-------------------------- + +Sometimes you may want just a small list of news items tucked to the bottom of +an index page that's otherwise full of other content. Mark a block with +:css:`.m-landing-news` and put a list of articles in it. The :html:`

` can +be used to link to the blog front page; if you use the :html:`` tag for +specifying article dates, it will be aligned to the right. Example: + +.. code-figure:: + + .. code:: html + +
+
+
+
Latest news on our blog »
+
+
Jan 16, 2018The latest article
+
Dec 09, 2017A slightly older article
+
+
+
+
+ + + .. raw:: html + +
+
+
+
Latest news on our blog »
+
+
Jan 16, 2018The latest article
+
Dec 09, 2017A slightly older article
+
+
+
+
+ diff --git a/doc/pelican/theme.rst b/doc/pelican/theme.rst index 7baca8a9..dcaa5a03 100644 --- a/doc/pelican/theme.rst +++ b/doc/pelican/theme.rst @@ -495,6 +495,26 @@ above: both :rst:`:landing:` and :rst:`:header:` is present, :rst:`:header:` is ignored. However, it works as expected if just :rst:`:cover:` is present. +`News on index page`_ +--------------------- + +If you override the index page to a custom landing page, by default you lose +the list of latest articles. That might cause the website to appear stale when +you update just the blog. In order to fix that, it's possible to show a block +with latest articles on the index page using the :py:`M_NEWS_ON_INDEX` setting. +It's a tuple of :py:`(title, count)` where :py:`title` is the block header +title that acts as a link to :py:`M_BLOG_URL` and :py:`count` is the max number +of articles shown. Example configuration: + +.. code:: py + + M_NEWS_ON_INDEX = ("Latest news on our blog", 3) + +.. note-success:: + + You can see how this block looks on the Magnum Engine main page: + http://magnum.graphics + `(Social) meta tags for pages`_ ------------------------------- diff --git a/pelican-theme/templates/page.html b/pelican-theme/templates/page.html index 70972616..3250ace9 100644 --- a/pelican-theme/templates/page.html +++ b/pelican-theme/templates/page.html @@ -110,6 +110,20 @@ {% endif %} + {% if page.save_as == 'index.html' and not page.url and M_NEWS_ON_INDEX %} +
+
+
+
{{ M_NEWS_ON_INDEX[0]|e }} »
+
+ {% for article in articles[0:M_NEWS_ON_INDEX[1]] %} +
{{ article.locale_date }}{{ article.title|e }}
+ {% endfor %} +
+
+
+
+ {% endif %} {% if page.footer %} diff --git a/pelican-theme/test/init.py b/pelican-theme/test/init.py index 0106bf02..935e4285 100644 --- a/pelican-theme/test/init.py +++ b/pelican-theme/test/init.py @@ -105,8 +105,8 @@ class BlogTestCase(BaseTestCase): 'DATE_FORMATS': {'en': ('en_US.UTF-8', '%b %d, %Y')}, 'M_FINE_PRINT': None, 'M_DISABLE_SOCIAL_META_TAGS': True, - 'PAGE_PATHS': ['pages'], # doesn't exist - 'ARTICLE_PATHS': ['.'], + 'PAGE_PATHS': ['pages'], # doesn't exist, usually + 'ARTICLE_PATHS': [''], 'AUTHOR_SAVE_AS': 'author-{slug}.html', 'AUTHOR_URL': 'author-{slug}.html', 'CATEGORY_SAVE_AS': 'category-{slug}.html', diff --git a/pelican-theme/test/blog_news_on_index/article.rst b/pelican-theme/test/blog_news_on_index/article.rst new file mode 100644 index 00000000..ea8d0b95 --- /dev/null +++ b/pelican-theme/test/blog_news_on_index/article.rst @@ -0,0 +1,4 @@ +An article +########## + +:date: 2017-12-09 diff --git a/pelican-theme/test/blog_news_on_index/article2.rst b/pelican-theme/test/blog_news_on_index/article2.rst new file mode 100644 index 00000000..9d50d4a8 --- /dev/null +++ b/pelican-theme/test/blog_news_on_index/article2.rst @@ -0,0 +1,4 @@ +Article with an especially elongated headline so it blows all the shit up in a totally bad way +############################################################################################## + +:date: 2018-01-16 diff --git a/pelican-theme/test/blog_news_on_index/article3.rst b/pelican-theme/test/blog_news_on_index/article3.rst new file mode 100644 index 00000000..75c77564 --- /dev/null +++ b/pelican-theme/test/blog_news_on_index/article3.rst @@ -0,0 +1,4 @@ +Article that's not shown +######################## + +:date: 2014-02-14 diff --git a/pelican-theme/test/blog_news_on_index/index.html b/pelican-theme/test/blog_news_on_index/index.html new file mode 100644 index 00000000..2a094bf4 --- /dev/null +++ b/pelican-theme/test/blog_news_on_index/index.html @@ -0,0 +1,42 @@ + + + + + Main page | A Pelican Blog + + + + + + +
+
+
+ A Pelican Blog +
+
+
+
+
+
+
+
+
Main page
+
+
+
+
+
+
Latest rants on our blog »
+
+
Jan 16, 2018Article with an especially elongated headline so it blows all the shit up in a totally bad way
+
Dec 09, 2017An article
+
+
+
+
+
+
+
+ + diff --git a/pelican-theme/test/blog_news_on_index/pages/index.rst b/pelican-theme/test/blog_news_on_index/pages/index.rst new file mode 100644 index 00000000..8253076f --- /dev/null +++ b/pelican-theme/test/blog_news_on_index/pages/index.rst @@ -0,0 +1,5 @@ +Main page +######### + +:save_as: index.html +:url: diff --git a/pelican-theme/test/test_blog.py b/pelican-theme/test/test_blog.py index 4fede2a8..bc50131c 100644 --- a/pelican-theme/test/test_blog.py +++ b/pelican-theme/test/test_blog.py @@ -525,3 +525,15 @@ class GlobalFavicon(BlogTestCase): }) self.assertEqual(self.actual_expected_contents('index.html')) + +class NewsOnIndex(BlogTestCase): + def init(self, args, **kwargs): + super().init(file, 'news_on_index', *args, **kwargs) + + def test(self): + self.run_pelican({ + 'M_BLOG_URL': 'http://our.blog/', + 'M_NEWS_ON_INDEX': ("Latest rants on our blog", 2) + }) + + self.assertEqual(*self.actual_expected_contents('index.html')) -- 2.30.2