Add new option abstract_delimiter (#173)

Superseedes #156

Author: Guts

mkdocs.yml

@@ -23,6 +23,8 @@ plugins:
         datetime_format: "%Y-%m-%d %H:%M"
         default_timezone: "Europe/Paris"
         default_time: "22:00"
+      abstract_chars_count: 160
+      abstract_delimiter: <!-- more -->
       image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
       match_path: ".*"
       pretty_print: false

mkdocs_rss_plugin/plugin.py

@@ -47,6 +47,7 @@ class GitRssPlugin(BasePlugin):
 
     config_scheme = (
         ("abstract_chars_count", config_options.Type(int, default=160)),
+        ("abstract_delimiter", config_options.Type(str, default="<!-- more -->")),
         ("categories", config_options.Type(list, default=None)),
         ("comments_path", config_options.Type(str, default=None)),
         ("date_from_meta", config_options.Type(dict, default=None)),
@@ -256,7 +257,9 @@ def on_page_content(
                 ),
                 created=page_dates[0],
                 description=self.util.get_description_or_abstract(
-                    in_page=page, chars_count=self.config.get("abstract_chars_count")
+                    in_page=page,
+                    chars_count=self.config.get("abstract_chars_count"),
+                    abstract_delimiter=self.config.get("abstract_delimiter"),
                 ),
                 guid=page.canonical_url,
                 image=self.util.get_image(

mkdocs_rss_plugin/util.py

@@ -345,17 +345,21 @@ def get_date_from_meta(
 
         return out_date
 
-    def get_description_or_abstract(self, in_page: Page, chars_count: int = 160) -> str:
+    def get_description_or_abstract(
+        self, in_page: Page, chars_count: int = 160, abstract_delimiter: str = None
+    ) -> str:
         """Returns description from page meta. If it doesn't exist, use the \
         {chars_count} first characters from page content (in markdown).
 
         :param Page in_page: page to look at
         :param int chars_count: if page.meta.description is not set, number of chars \
         of the content to use. Defaults to: 160 - optional
+        :param str abstract_delimiter: description delimeter, defaults to None
 
         :return: page description to use
         :rtype: str
         """
+
         description = in_page.meta.get("description")
 
         # Set chars_count to None if it is set to be unlimited, for slicing.
@@ -374,8 +378,19 @@ def get_description_or_abstract(self, in_page: Page, chars_count: int = 160) ->
                 "because an item must have a description."
             )
             return ""
+        elif (
+            abstract_delimiter
+            and (
+                excerpt_separator_position := in_page.markdown.find(abstract_delimiter)
+            )
+            > -1
+        ):
+            return markdown.markdown(
+                in_page.markdown[:excerpt_separator_position],
+                output_format="html5",
+            )
         # If chars count is unlimited, use the html content
-        elif in_page.content and chars_count is None:
+        elif in_page.content and chars_count == -1:
             if chars_count is None or len(in_page.content) < chars_count:
                 return in_page.content[:chars_count]
         # Use markdown

tests/fixtures/docs/blog/posts/sample_blog_post.md

@@ -0,0 +1,18 @@
+---
+date: 2023-02-12
+authors: [guts]
+categories:
+  - Blog
+---
+
+# Blog sample
+
+I'm a really short intro.
+
+<!-- more -->
+
+## This part won't show up in RSS feed
+
+### What is Lorem Ipsum?
+
+Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

tests/fixtures/docs/page_with_meta_bad_date.md

@@ -3,6 +3,6 @@ date: 2022-03-30 15:09:34
 description: Test page with meta keys as singular and values as iterable
 ---
 
-# Test page with meta keys as singular
+# Test page with meta keys as singular but bad date
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

tests/fixtures/docs/page_with_meta_singulars.md

@@ -14,5 +14,3 @@ tags:
 # Test page with meta keys as singular
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
-

tests/test_build.py

@@ -322,8 +322,13 @@ def test_simple_build_item_length_unlimited(self):
             self.assertEqual(feed_parsed.bozo, 0)
 
             for feed_item in feed_parsed.entries:
-                if feed_item.title not in ("Page without meta with short text",):
-                    self.assertGreaterEqual(len(feed_item.description), 150)
+                if feed_item.title not in (
+                    "Page without meta with short text",
+                    "Blog sample",
+                ):
+                    self.assertGreaterEqual(
+                        len(feed_item.description), 150, feed_item.title
+                    )
 
     def test_simple_build_pretty_print_enabled(self):
         with tempfile.TemporaryDirectory() as tmpdirname:

tests/test_config.py

@@ -57,6 +57,7 @@ def test_plugin_config_defaults(self):
         # default reference
         expected = {
             "abstract_chars_count": 160,
+            "abstract_delimiter": "<!-- more -->",
             "categories": None,
             "comments_path": None,
             "date_from_meta": None,
@@ -80,6 +81,7 @@ def test_plugin_config_image(self):
         # reference
         expected = {
             "abstract_chars_count": 160,
+            "abstract_delimiter": "<!-- more -->",
             "categories": None,
             "comments_path": None,
             "date_from_meta": None,