Improved documentation on layout Lookup Order - what do you think?

dgasparri · September 4, 2022, 12:10pm

Hi all,

I found the documentation about naming/ordering of template files rather obscure, so I tried to improve it.

Also I found a few posts on the forum asking how to name template files:

The topic is complex, so I tried to put it all together in a (I hope) clear way providing also an example.

Proposed doc page (preview):

Original doc page: Hugo's Lookup Order | Hugo

What do you think? Suggestions? Here is the pull request Better explanation of Kind, Session, Type, Layout on final layout path by dgasparri · Pull Request #1805 · gohugoio/hugoDocs · GitHub

Duccio

tut · November 26, 2022, 2:44pm

github.com/gohugoio/hugoDocs

Comment by jmooring to Better explanation of Kind, Session, Type, Layout on final layout path

gohugoio:master ← dgasparri:patch-3

You obviously put a lot of work into this, but it is way too long and difficult …to read. I tried to read it several times using the Netlfiy preview site, but my eyes just glazed over. In addition to being too long and dense, this syntax makes it really difficult to read: - `<LAYOUT>` (11 instances) - `<ROOT FOLDER>` (10 instances) - `<THEME>` (6 instances) - etc. This page needs to have a _brief_ introduction, lookup tables, and perhaps some simple examples at the bottom of the page. Users commonly want to know answers to these simple questions: - Where do I put a template to override the list view for my posts? - Where do I put a template to override the page view for my posts? - Where do I put a template to override my home page? - Where do I put a template to override my taxonomy pages? - Where do I put a template to override my term pages? I think your detailed explanation is better suited to a blog post or a "tips and tricks" article somewhere.

Topic		Replies	Views
Preview actual template lookup order feature	7	1651	April 9, 2018
My experiences with Hugo's template lookup order tips & tricks	5	6667	August 21, 2019
Lookup Order for Partials support	6	1145	March 6, 2017
Custom layout for inner pages	1	682	October 25, 2017
Hugo without the filesystem lookup order? support	1	35	November 7, 2024

Improved documentation on layout Lookup Order - what do you think?

Related topics