Skip to content

Conversation

@SumaiyaaRq
Copy link
Contributor

Fixes

Description

This PR enhances the blog post feature by adding the ability for authors to include custom excerpts for each blog post. It allows for better control over the preview content that readers will see, providing an engaging summary for the post. If no custom excerpt is provided, the first 100 words of the blog post body will be used by default . This improves content presentation and increases the chances of engaging readers right from the preview.

Technical Details

  1. Added an excerpt field to contents.lr for authors to input custom excerpts
    for blog posts.
  2. Updated post.html to handle and display the excerpt field and provided a default
    mechanism to use first 100 words if the excerpt is not provided.
  3. Modified the blog-post.ini to include excerpt field.

Tests

  1. Open the homepage of the project.
  2. Go to Blog> CC Open Source Blog
  3. See Changes

Screenshots

Sample Blog for Testing the Excerpt Field :
Screenshot 2024-11-06 at 10 59 57 PM

Excerpt Field preview:
Screenshot 2024-11-06 at 10 53 24 PM

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@SumaiyaaRq SumaiyaaRq requested review from a team as code owners November 6, 2024 18:23
@SumaiyaaRq SumaiyaaRq requested review from Cronus1007, TimidRobot and possumbilities and removed request for a team November 6, 2024 18:23
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update to support markdown excerpts


[fields.excerpt]
label = Excerpt
type = text
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please:

  1. make this markdown instead of text
  2. restore the newline at end of file

{{ render_authors_byline(post) }}
<div class="excerpt">
{{ post.body | excerpt | string | striptags() | truncate(100) }}
{{ post.excerpt | default(post.body) | striptags | truncate(100) }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update to support markdown excerpts. Something like:

         {% if post.excerpt %}
           {{ post.excerpt }}
         {% else %}
           {{ post.body | excerpt | string | striptags() | truncate(100) }}
         {% endif %}

@TimidRobot
Copy link
Member

@SumaiyaaRq thank you for your work on this!!

Closing this pull request in favor of the earlier:

@TimidRobot TimidRobot closed this Dec 10, 2024
@SumaiyaaRq SumaiyaaRq deleted the feature/optional-excerpt-field-for-blogpost branch December 10, 2024 15:13
@TimidRobot TimidRobot self-assigned this Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

[Feature] Add Optional Excerpt Field to Blog Post Format

2 participants