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

Feat/style and publish front matter summary in article #402

Conversation

f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Feb 21, 2025

Description

This PR changes how a front matter summary added by a user is handled. As of now, most of the articles don't have proper summaries that introduce their contents. This feature will hopefully help us raise more interest among developers in creating nice summaries.

First off, this is an example of a good summary that quickly provides clues about the contents and helps the reader to decide in a matter of seconds if they should read it.

Back to the summary creation, Hugo offers three ways to add summaries:

  • Front matter summary -- this PR changes how it is handled
  • Manual summary -- nothing changed
  • Automatic summary -- nothing changed

To create a front matter summary, you need to add the following to your article's front matter:

title: 'My article'
date: ...
summary: 'This is a front matter summary.'

In addition to the standard behavior of showing the summary on a list page, this PR also placed it at the beginning of an article in a different formatting style (link to a preview).

This is how a front matter summary looks in a list page:

image

This is how the proposed summary looks in an article:

image

Related

Testing

Tested locally.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow force-pushed the feat/style_and_publish_front_matter_summary_in_article branch from 227b2cf to 8bc0b55 Compare February 21, 2025 09:22
@FBEZ
Copy link
Collaborator

FBEZ commented Feb 24, 2025

I completely support this change. Not only because it's a standard (both in academic settings and elsewhere) but also because it forces to author to reflect on the overall goal of their article. Dealing the summary/abstract through the front matter makes it sense and it's the most "structured" way to deal with it.

@f-hollow f-hollow force-pushed the feat/style_and_publish_front_matter_summary_in_article branch from 8bc0b55 to 115446a Compare February 27, 2025 08:35
@f-hollow f-hollow force-pushed the feat/style_and_publish_front_matter_summary_in_article branch from 115446a to 625b538 Compare February 27, 2025 08:43
@pedrominatel pedrominatel merged commit e4261cc into espressif:main Feb 27, 2025
3 of 4 checks passed
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

Successfully merging this pull request may close these issues.

3 participants