hugo-clarity
hugo-clarity copied to clipboard
'Featured' tag and 'featured' param in example might be confusing
In testing #353 I noticed that in our exampleSite we have a featured post ("Markdown Syntax Guide") with both of these things set:
-
featured = true -
tags = [ ... "featured" ]
Being able to feature posts is a good...feature! But the functionality to do so only operates on the featured param itself (the first item above), not the tag.
This seems like it could be confusing to users. Would it be worth doing one of these?
- removing the "featured" tag from the example featured post, or
- automatically adding a "featured" tag whenever the
featuredparam is set totrue, or - having the check for which posts to feature look at both the param and the tags; either would enable a post to be featured
Any opinions?
I think it might be better to remove the tag from the current one as the first option, then add a new post about featured post(and maybe pinned post) to demonstrate how it works.