[Blog Plugin] RSS Feed #5822

simondueckert · 2023-08-08T20:47:18Z

simondueckert
Aug 8, 2023

A blog has by definition an RSS feed to subscribe to it. Will the blog plugin generate a static rss file for the blog?

Answered by squidfunk

Aug 8, 2023

Please, read our documentation before asking questions.

View full answer

squidfunk · 2023-08-08T20:55:41Z

squidfunk
Aug 8, 2023
Maintainer

Please, read our documentation before asking questions.

1 reply

simondueckert Aug 8, 2023
Author

sry 🙈

pchalasani · 2023-09-04T17:01:23Z

pchalasani
Sep 4, 2023

@squidfunk I set up the rss feed following those instructions, and when I look at the page source I now see the xml links. However is there a way to show an RSS symbol on the blog? I did set up an "image" param in the yaml.

6 replies

kamilkrzyskow Jun 19, 2024
Collaborator

Only the rss feed in the head section is added:

mkdocs-material/src/templates/base.html

Lines 63 to 77 in f1ffead

    
           <!-- RSS feed --> 
        
           {% if "rss" in config.plugins %} 
        
             <link 
        
               rel="alternate" 
        
               type="application/rss+xml" 
        
               title="{{ lang.t('rss.created') }}" 
        
               href="{{ 'feed_rss_created.xml' | url }}" 
        
             /> 
        
             <link 
        
               rel="alternate" 
        
               type="application/rss+xml" 
        
               title="{{ lang.t('rss.updated') }}" 
        
               href="{{ 'feed_rss_updated.xml' | url }}" 
        
             /> 
        
           {% endif %}

The image setting here is not processed by the theme:

https://guts.github.io/mkdocs-rss-plugin/configuration/#image

You can add the icon manually, using the emoji syntax:

https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
[:material-rss:](RSS_FEED_URL)

Gregb87 Jun 20, 2024

Hi Kamil.

Thanks for that fast response.

Yes, I can see the RSS part in the section of the base.html file in the material theme. So that part is already done.
The image setting - Thanks for letting me know about that not being processed by the theme. Seems like the docs at that link are a bit misleading.
Thanks for this tip also! Only question I have, where do you actually add the emoji syntax? I assume the mkdocs.yml file but not sure.

kamilkrzyskow Jun 20, 2024
Collaborator

@Gregb87
The mkdocs-rss-plugin plugin and the mkdocs-material theme are separate entities. The configuration at https://guts.github.io/mkdocs-rss-plugin/configuration/ only influences the generated feeds, the theme made it more convenient to automatically add the feed links to the <head> section, otherwise you'd have to add them yourself. You shouldn't think that both somehow work in unison.

Therefore, I don't think that 2. is misleading, as it concerns adding an <image> tag to the RSS feed itself not the built site.
This setting might be useful to create a logo image for your feed if somebody uses some sort of aggregation tool, like inoreader.

https://www.w3schools.com/xml/rss_tag_image.asp

The syntax I provided above :material-rss: is the Markdown emoji syntax, so you have to write it in a .md Markdown file (you also have to properly configure the mkdocs.yml file, as per the link in the previous comment).

https://facelessuser.github.io/pymdown-extensions/extensions/emoji/

To give you some more ideas:

a) You can add the syntax to the blog/index.md file to make it appear at the top of the blog homepage.
b) You can also use the extra.social section and add the icon at the bottom using a similar syntax:

https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links
Here you input the file path to an icon so in this case material/rss

c) You can also use the rendered :material-rss: HTML code and put it in some other place using template overrides:

https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme

Tip

Note that :material-rss: is the example I use, use the emoji search bar to find other variants.

Gregb87 Jun 21, 2024

@kamilkrzyskow

Thanks again for the information.

I've got a few other things to take care of today. But will take this info on board and get back here with how we went setting it up.

Gregb87 Jun 27, 2024

@kamilkrzyskow
Thanks for your help on this one.
Closing the loop and reporting that we have this working now using the extra.social option.
The RSS feed icon shows up in the social icons area now on each page, with this yml syntax:

- icon: material/rss
  link: /feed_rss_updated.xml
  name: Subscribe to our RSS Feed

Uh oh!

[Blog Plugin] RSS Feed #5822

Uh oh!

simondueckert Aug 8, 2023

Replies: 2 comments · 7 replies

Uh oh!

squidfunk Aug 8, 2023 Maintainer

Uh oh!

simondueckert Aug 8, 2023 Author

Uh oh!

pchalasani Sep 4, 2023

Uh oh!

kamilkrzyskow Jun 19, 2024 Collaborator

Uh oh!

Gregb87 Jun 20, 2024

Uh oh!

Uh oh!

kamilkrzyskow Jun 20, 2024 Collaborator

Uh oh!

Gregb87 Jun 21, 2024

Uh oh!

Uh oh!

Gregb87 Jun 27, 2024

simondueckert
Aug 8, 2023

Replies: 2 comments 7 replies

squidfunk
Aug 8, 2023
Maintainer

simondueckert Aug 8, 2023
Author

pchalasani
Sep 4, 2023

kamilkrzyskow Jun 19, 2024
Collaborator

kamilkrzyskow Jun 20, 2024
Collaborator