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

[Feature] Add Optional Excerpt Field to Blog Post Format #840

Open
1 task done
Queen-codes opened this issue Nov 4, 2024 · 0 comments · May be fixed by #845 or #846
Open
1 task done

[Feature] Add Optional Excerpt Field to Blog Post Format #840

Queen-codes opened this issue Nov 4, 2024 · 0 comments · May be fixed by #845 or #846
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 💪 skill: lektor Requires proficiency in 'Lektor' 🏁 status: ready for work Ready for work

Comments

@Queen-codes
Copy link

Queen-codes commented Nov 4, 2024

Problem

Currently, excerpts are automatically generated by truncating the first 100 words of the blog post. This way, the authors don't manually control what shows in the excerpt, and sometimes, this can lead to less meaningful or effective previews, especially when the first 100 words don’t capture the essence of the post or lure readers to want to read about the post.

Description

This feature would add an optional excerpt field to the contents.lr blog template for new authors to fill. Authors would have the option to manually add a custom excerpt to their posts, which would be used as the preview text. If the excerpt field is left empty, the current logic will apply, and the system will truncate the first 100 words of the post body.

The logic would be then modified to check for the presence of the excerpt field. If provided, the custom excerpt will be used; if not, the fallback behaviour will generate the excerpt from the body content.

Alternatives

Continue using only the automatic truncation of the first 100 words. This limits control over the excerpt and may not provide ideal previews.

Additional context

In #351, it was suggested that the Write a blog post page documentation be updated to include how to add excerpt:

Implementation

  • I would be interested in implementing this feature.
@Queen-codes Queen-codes added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Nov 4, 2024
@cc-open-source-bot cc-open-source-bot moved this to Triage in Applications Nov 4, 2024
@TimidRobot TimidRobot added help wanted Open to participation from the community 🏁 status: ready for work Ready for work 📄 aspect: text Concerns the textual material in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 💪 skill: lektor Requires proficiency in 'Lektor' and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 5, 2024
@TimidRobot TimidRobot moved this from Triage to Backlog in Applications Nov 5, 2024
@Queen-codes Queen-codes linked a pull request Nov 6, 2024 that will close this issue
7 tasks
@SumaiyaaRq SumaiyaaRq linked a pull request Nov 6, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 💪 skill: lektor Requires proficiency in 'Lektor' 🏁 status: ready for work Ready for work
Projects
Status: Backlog
2 participants