Lsp-mode: [docs] - Support for RSS

[ericdallo]

[ericdallo]

I'm waiting for this PR to add to lsp-mode: https://github.com/squidfunk/mkdocs-material/pull/1928

[yyoncho]

I think we are done here but I am unable to find RSS on the website?

[ericdallo]

Yeah, me too, maybe @Guts knows why :thinking: ?

[Guts]

As mentioned in the documentation (but maybe it's not clear enough, I'll reformulate):

feed_rss_created.xml for latest created pages
feed_rss_updated.xml for latest updated pages

So, in your case, RSS files can be viewed:

• Into the gh-pages branch (to check for example):

  • created content
  • updated content

• served on your website:

  • created content
  • updated content

[ericdallo]

Thanks @Guts, I think @yyoncho was referring to the RSS icon, if it should appear somewhere in the webpage

[yyoncho]

Thanks @Guts, I think @yyoncho was referring to the RSS icon, if it should appear somewhere in the webpage

Maybe we should link it from the footer, no?

[Guts]

Thanks @Guts, I think @yyoncho was referring to the RSS icon, if it should appear somewhere in the webpage

The plugin doesn't insert anything into the HTML. You are free to add an icon in the footer (example here https://github.com/geotribu/website/blob/master/mkdocs.yml#L81-L83) or a Feedly button or any image with a link to the feed 😃.

[clemera]

It would be good to reference the feed in the header so browsers and other tools can detect the feed, something like:

<link rel="alternate" type="application/rss+xml" title="RSS" href="rss.xml">

[clemera]

It seems the feed is only for the language pages and not the blog/tutorials?

[ericdallo]

Yeah, for some reason it didn't include the blog/tutorials, do you know why @Guts ?
I'm not too familiar with RSS

[Guts]

I do not know your docs structure so hard to help, but looking at your CI build, it seems to be a lack of git history during build: https://github.com/emacs-lsp/lsp-mode/runs/1136396394#step:8:126 (the git revision date uses the same git logic than the rss plugin).

These plugins use the git log to determine creation and update dates. if there is no git log during the docs build, it fallbacks to the build date, so every page will have the same dates... It's easy to see looking at the pages footer or pubDate tag in the RSS output.

See: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin#note-when-using-build-environments

Why using Docker builds to deploy static files? You could use a simple CI workflow using directly a requirements file for your plugins and using the mkdocs gh-deploy included command. For example, for the plugin documentation: https://github.com/Guts/mkdocs-rss-plugin/blob/master/.github/workflows/docs_to_gh_pages.yml.

[ericdallo]

@Guts it's because all laguages pages are generated dynamically every build according to elisp files from this repo /clients folder , but the other pages are versioned.

[Guts]

Okay got it, si that explains why from the plugin point of view languages pages are the latest created and updated content.

I'm working on a feature to handle the meta.date attribute for overriding git log. It could help but I'll need some free time...

[ericdallo]

No problem, thanks @Guts