RSS feed

Author: kastnerp

.github/workflows/deploy.yml

@@ -36,6 +36,7 @@ jobs:
       - run: pip install mkdocs-glightbox
       - run: pip install markdown-include
       - run: pip install mkdocs-include-markdown-plugin
+      - run: pip install mkdocs-rss-plugin
       - run: mkdocs gh-deploy --force
         env:
           GithubAccessToken: ${{ secrets.SMUR }}

mkdocs.yml

@@ -191,6 +191,40 @@ plugins:
       branch: main
       docs_path: docs/
       token: !ENV ["GithubAccessToken"]
+  - rss:
+      abstract_chars_count: 160  # -1 for full content
+      abstract_delimiter: <!-- more -->
+      categories:
+        - tags
+      comments_path: "#__comments"
+      date_from_meta:
+        as_creation: "date" # means from page.meta.date
+        as_update: "git" # means from git log
+        datetime_format: "%Y-%m-%d %H:%M"
+        default_time: "09:30"
+        default_timezone: Europe/Paris
+      enabled: true
+      #feed_description: "A Vertically Integrated Project at Georgia Tech"  # MkDocs site_description: will be used if this key is not present
+      feeds_filenames:
+        json_created: feed_json_created.json
+        json_updated: feed_json_updated.json
+        rss_created: feed_rss_created.xml
+        rss_updated: feed_rss_updated.xml
+      feed_title: "My custom feed title"  # MkDocs site_name: will be used if this key is not present
+      feed_ttl: 1440
+      image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
+      json_feed_enabled: true
+      length: 20
+      match_path: ".*"
+      pretty_print: false
+      rss_feed_enabled: true
+      url_parameters:
+        utm_source: "documentation"
+        utm_medium: "RSS"
+        utm_campaign: "feed-syndication"
+      use_git: true
+      use_material_blog: true
+      use_material_social_cards: true
 
   - multirepo:
       # (optional) tells multirepo to cleanup the temporary directory after site is built.