Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Blog feeds render nicely by default (XSLT stylesheet) #9197

Open
1 of 2 tasks
slorber opened this issue Aug 3, 2023 · 6 comments · May be fixed by #9252
Open
1 of 2 tasks

Blog feeds render nicely by default (XSLT stylesheet) #9197

slorber opened this issue Aug 3, 2023 · 6 comments · May be fixed by #9252
Labels
difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. proposal This issue is a proposal, usually non-trivial change

Comments

@slorber
Copy link
Collaborator

slorber commented Aug 3, 2023 •
edited

Have you read the Contributing Guidelines on issues?

Motivation

It is possible to style how an XML file is rendered by browsers thanks to XML XSLT stylesheets:

https://darekkay.com/blog/rss-styling/

image

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet href="/rss.xsl" type="text/xsl"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:media="http://search.yahoo.com/mrss/">
  ...
</feed>

I think it could be useful to have a beautiful XML output by default for XML-based feeds.

We could also add an icon in the blog sidebar to link to that feed, helping users know that a feed is available.

image

(this could become later a "blog sidebar item type", related to #7227)

Also, it can be the occasion to do some additional cleanup in the RSS feed item content:

CleanShot 2023-08-03 at 18 28 19@2x CleanShot 2023-08-03 at 18 29 59@2x

Are the className attributes set by the Docusaurus theme really needed to be in the feed item content? I doubt it leads to any significant styling difference from RSS readers considering they don't have the stylesheet.

Self-service

  • I'd be willing to do some initial work on this proposal myself.
@slorber slorber added good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. proposal This issue is a proposal, usually non-trivial change labels Aug 3, 2023
@caramelmelmel
Copy link

@slorber can I take this issue? Is there any prerequisite knowledge to taking this issue?

@slorber
Copy link
Collaborator Author

slorber commented Aug 5, 2023

You can submit a PR if you think you are able to work on it. It's up to you to figure out if you have the required skills.

@caramelmelmel
Copy link

@slorber Give me a week to investigate on this and then get back to you

@Xebec19 Xebec19 linked a pull request Aug 23, 2023 that will close this issue
Open
3 tasks
@slorber slorber mentioned this issue Aug 24, 2023
Open
@KirtiKamal
Copy link

@slorber what actually you want in this issue. can you please specify. I am new to opensource by knowing more about this issue i will be able to contribute to this issue

@slorber
Copy link
Collaborator Author

slorber commented Sep 25, 2023

@KirtiKamal we already have a PR for this issue that I should review soon: #9252

If you don't understand what the issue is about, then try to find another to contribute to. We unfortunately don't have time to help you figure it out 😅

@jeacott1
Copy link

I'd like to see an entire docusaurus site available as xml - xslt-fo could be a nice way to finally generate some good looking pdf content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(rss feed): added xslt for rss feed Xebec19/docusaurus
4 participants
@slorber @jeacott1 @caramelmelmel @KirtiKamal