Enable summary for the post in blog

[aldrineeinsteen]

Enable summary into the posts of every blog

The blog post looks odd without any summary.

[kentnek]

oh yes I was thinking about this too. I don't mind adding an option to expose the summary, let me try that.

[jakewies]

Hey @aldrineeinsteen ! Thanks for your interest in this theme. Hugo themes are overridable, meaning Hugo will look at your project files to resolve a layout before it looks into the theme's files.

If you installed the theme following the README, you should have installed it at /themes/hugo-theme-codex. The page you are referring to is the blog list layout, which can be found at /themes/hugo-theme-codex/layouts/_default/list.html. If you wish to add a summary to each blog post, you can copy the contents of /themes/hugo-theme-codex/layouts/_default/list.html to your /layouts/_default/list.html or /layouts/blog/list.html if you are already using the _default list template.

From there you can inject a summary to each post.

EDIT: @kentnek, do you think it would be better to add this as a configurable option? This is a design decision, and honestly I don't have a preference. Since @aldrineeinsteen is the first to bring this to our attention, maybe it's not something we need to expose just yet, but can support on a one off basis.

[kentnek]

@jakewies oh yes it should be configurable, as I don't want to force that on other people either 😂 I actually had that in mind earlier as some of my blog posts already have the <--more--> summary divider, which is supported by the previous theme that I used.

[jakewies]

Good idea. How do you envision the configuration for this looking? I think we could separate the config.toml params by page. For example:

# config.toml

[params]
   # ... site params

   # ... blog params
   [blog]
     showSummary = true

This is just the first idea that came to my noggin. What do you think? Do you have another solution?

[jakewies]

Also, @aldrineeinsteen are you looking to have each blog post's description in the list template? The description of a blog post is defined in each post's frontmatter.description. Currently this value is being used as site metadata.

[kentnek]

@jakewies no he wanted to show Hugo's Content Summaries, which is defined in .Summary.

I actually wanted to make showSummary a site-wide param. Dealing with page-wide params is kinda tricky as the page's key ("blog") is not the same with every user's website. Also a showSummary in every page param complicates the config I think, if the user wants to show summaries in all pages.

[jakewies]

@kentnek ok cool I didn't know this was an option. I just tested it out, and the Rich Content example post outputs some wonky text because it uses shortcodes. From first glance it looks like the .Summary value and shortcodes don't play nice together.

[kentnek]

Hmm then I guess we can add in the <!--more--> divider before the rich content for the demo to work.

[aldrineeinsteen]

Good idea. How do you envision the configuration for this looking? I think we could separate the config.toml params by page. For example:

# config.toml

[params]
   # ... site params

   # ... blog params
   [blog]
     showSummary = true

This is just the first idea that came to my noggin. What do you think? Do you have another solution?

I haven't thought of exposing the same as a configuration; i have pushed a code to display the summary by default along with pagination:

[aldrineeinsteen]

Hmm then I guess we can add in the <!--more--> divider before the rich content for the demo to work.

Yes, when started adding summary found the pagination was missing, i have added the same in #75

[aldrineeinsteen]

Good idea. How do you envision the configuration for this looking? I think we could separate the config.toml params by page. For example:

# config.toml

[params]
   # ... site params

   # ... blog params
   [blog]
     showSummary = true

This is just the first idea that came to my noggin. What do you think? Do you have another solution?

Added support for configuration in #75