Feat/style and publish front matter summary in article #402
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
To create a front matter summary, you need to add the following to your article's front matter:
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:
This is how the proposed summary looks in an article:
Related
Testing
Tested locally.
Checklist
Before submitting a Pull Request, please ensure the following: