search

luizdepra / hugo-coder

A minimalist blog theme for hugo.
MIT License
2.73k stars 1.07k forks source link

Missing documentation/example of "series" taxonomy #865

Open JensRantil opened 11 months ago

JensRantil commented 11 months ago

https://github.com/luizdepra/hugo-coder/blob/main/archetypes/posts.md contains three types of taxonomies. One of them is "series". How do I use "series"? Could it be added to the demo site? Document in README?

Background is that I am writing my first blog post series right now. But given that I don't know how I should use series (IIRC, it gave me an error). I currently link to a category to list the series, but I assume I should somehow use series.

luizdepra commented 11 months ago

Hey!

There is an example of series on the demo. But, yeah, it is shady and undocumented.

https://hugo-coder.netlify.app/series/theme-demo/

JensRantil commented 11 months ago

Whoa! Missed that. Just curious, what's the intended difference semantically between series, tags and categories?

luizdepra commented 11 months ago

Ahh right. I forgot to explain that.

Tags are like keywords or small topics about a page. Ex: Python, Rust, Singleton Pattern, Facade Pattern, Bench Saw Categories are broader topics or genres. Ex: Programming Languages, Design Patterns, Woodworking Series are a way to group related posts. Let's say you wrote a sequence of 3 posts about how to build microservices with Go: "Building a microservice with Go", "Building a microservice with Go (part 2)" and "Better patterns for a microservice made with Go". So you could group them in a series like "Microservices made with Go".

JensRantil commented 7 months ago

@luizdepra Thanks for clarifying! This might be very useful to document in the README.

One follow-up question: Is there an easy way to add a description to a series? For example, adding something like "This series is about the different way you can customise a theme." to https://hugo-coder.netlify.app/series/theme-demo/.

luizdepra commented 7 months ago

@luizdepra Thanks for clarifying! This might be very useful to document in the README.

Sure. I need to rewrite some of the docs. It is getting really messy.

One follow-up question: Is there an easy way to add a description to a series? For example, adding something like "This series is about the different way you can customise a theme." to https://hugo-coder.netlify.app/series/theme-demo/.

Sadly, I don't see an easy way to do it. I think it is not possible to add an extra value to a series, tag or category with a simple configuration. But, It might be possible to override the index template for a series and add a description section. But you'll need to create a folder and a _index.md file for every series.

I think this text explains better: https://github.com/guayom/hugo-taxonomies