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.

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

Problem: Users have difficulty finding and browsing older blog content #18

Open
sliptonic opened this issue Oct 17, 2023 · 5 comments
Open

Comments

@sliptonic
Copy link
Contributor

Ondsel publishes approximately 1 blog post per week. The content has tags for things like 'thought leadership' 'FreeCAD', 'Assembly', etc.

Currently the left side column shows the last ~10 titles. If the user wants to browse older articles, the only option is to go back to the 10th oldest article and then use navigation at the bottom of the page to 'read previous' article.

We would like to implement better access to the content. This can take the form of

  • search tool
  • Pagination of older titles
  • tag cloud
  • browse by category.

It is not necessary to implement all of these. Recommendation for best practices are appreciated.

@patdavid
Copy link
Collaborator

After a busy lunar new year and mardi gras down here on the gulf coast, I'm setting aside some time to start hacking at blog improvements. What things do we want to address @prokoudine @sliptonic?

Can we list some things we want to fix up here in this issue and I can start hacking at them?

Also - I cannot seem to find a way to un swizzle a component - anyone have any ideas?

@prokoudine
Copy link
Collaborator

  1. The blog index pages (where you get pagination) should display 'description' from the front matter rather than the entire post and then link to the entire post in a quite visible way.
  2. There should be some form of navigation by topic, e.g. cloud of tags (but please suggest better solutions, if you have any).

That's the two most useful things to have.

@patdavid
Copy link
Collaborator

patdavid commented Feb 16, 2024

@prokoudine

  1. The blog index pages (where you get pagination) should display 'description' from the front matter rather than the entire post and then link to the entire post in a quite visible way.

This can be done, but the "docusaurus way" is to add a <!-- truncate --> line in your markdown files to indicate where the content should be cut off for list view on the /blog/ page. The everything above that line will be rendered in the /blog/ list page with a "Read more" button:

image

I can theoretically swizzle the bloglist component to modify this behavior, but I hesitate to modify core functionality if it can be avoided (to minimize problems upgrading later).

With that being said, it's up to you if you'd like me to go down that path.

So - do you want to use <!-- truncate --> to mark the summary view of blog posts, or should I modify (swizzle) the BlogList component and customize it to use a frontmatter description parameter?

[edit] - I should point out that my recommendation would be to use the "docusaurus way" if possible. ;)

@prokoudine
Copy link
Collaborator

Let's go the <!-- truncate --> way for now. My understanding is that's all I need to do to get what you displayed on the screenshot above?

@prokoudine
Copy link
Collaborator

Truncating was done today.

patdavid added a commit that referenced this issue Sep 10, 2024
Part of addressing #18 for user browsing blog content
prokoudine pushed a commit that referenced this issue Sep 12, 2024
Part of addressing #18 for user browsing blog content
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants