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 feed: add a first-class API to limit size of the RSS / Atom feeds #9179

Closed
1 of 2 tasks
slorber opened this issue Jul 27, 2023 · 2 comments · Fixed by #9189
Closed
1 of 2 tasks

Blog feed: add a first-class API to limit size of the RSS / Atom feeds #9179

slorber opened this issue Jul 27, 2023 · 2 comments · Fixed by #9189
Assignees
@johnnyreilly
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@slorber
Copy link
Collaborator

slorber commented Jul 27, 2023

Have you read the Contributing Guidelines on issues?

Description

Add an option: feed.limit: number | false | null = 20

Don't put all the blog posts in the feed by default

  • 20 = default value
  • false | null = no limit

See also my comments here:

#8378 (comment)

Has this been requested on Canny?

No response

Motivation

The RSS/Atom feeds files are too big for sites with large blogs, notably because the feeds contain the blog content.

It's not super useful to have everything inside the feed, and having the last 20 blog posts by default is good enough.

See #8378 (comment)

API design

No response

Have you tried building it?

No response

Self-service

  • I'd be willing to contribute this feature to Docusaurus myself.
@slorber slorber added the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Jul 27, 2023
@slorber slorber mentioned this issue Jul 27, 2023
Merged
3 tasks
@slorber
Copy link
Collaborator Author

slorber commented Jul 27, 2023

Note @johnnyreilly would like to work on this soon (#8378 (comment)). If in 2 or 3 weeks there's no PR open feel free to reclaim this issue and submit a PR :)

@Josh-Cena Josh-Cena added domain: content plugin Related to content plugin emitting metadata for theme consumption and removed domain: content plugin Related to content plugin emitting metadata for theme consumption labels Jul 28, 2023
@johnnyreilly johnnyreilly mentioned this issue Jul 31, 2023
Merged
3 tasks
@johnnyreilly
Copy link
Contributor

I've had a crack at it 😄 #9189

@GovanifY GovanifY mentioned this issue Feb 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnnyreilly johnnyreilly

Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(blog-plugin): limit option for blog feedOptions johnnyreilly/docusaurus
3 participants
@slorber @johnnyreilly @Josh-Cena