hugo new theme does not create a baseof.html #3576

juh2 · 2017-06-10T09:57:26Z

As Block-Templates are the new default I think that the directory layout of a theme created by hugo new should reflect this and create a baseof.html in _default.

The text was updated successfully, but these errors were encountered:

digitalcraftsman · 2017-06-10T10:35:09Z

Hello @juh2,

Block-Templates are the new default I think

We make no assumptions about the user and the structure of his theme. Block templates are still optional, hence they don't have to be used by default.

But it would make sense to encourage theme creators to make use of baseof.html since it removes a lot of redundancy. Creating a baseof.html when executing hugo new theme xyz might also help to increase its adaption.

If you think baseof.html should be created by default then label this issue as a feature request.

What remains is the question whether the adoption of block templates outweighs the assumptions of the users and his intended theme structure.

juh2 · 2017-06-10T11:10:06Z

Thanks for the clarification.

I see no obvious button to label this issue as feature request.

Could someone with more insight or rights do this?

TIA

bep · 2017-06-10T17:04:52Z

I agree with @juh2 that most would really want a baseof.html if they knew about it. But we should then set up a basic structure with a content section etc.

rdwatters · 2017-06-10T21:13:47Z

Here's what is currently generated:

.
├── LICENSE.md
├── archetypes
│   └── default.md
├── layouts
│   ├── 404.html
│   ├── _default
│   │   ├── list.html
│   │   └── single.html
│   ├── index.html
│   └── partials
│       ├── footer.html
│       └── header.html
├── static
│   ├── css
│   └── js
└── theme.toml

How about the addition of baseof.html, shortcodes, and img? Seems like content and data should stay independent of the theme scaffolding. Also, I'm not especially firm on img:

.
├── LICENSE.md
├── archetypes
│   └── default.md
├── layouts
│   ├── 404.html
│   ├── _default
│   │   ├── baseof.html
│   │   ├── list.html
│   │   └── single.html
│   ├── index.html
│   ├── partials
│   │ ├── footer.html
│   │ └── header.html
│   └── shortcodes
├── static
│   ├── css
│   ├── img
│   └── js
└── theme.toml

bep · 2017-06-10T21:45:08Z

Let us keep this issue about ... besof.html and not add a lot of other issues on top.

rdwatters · 2017-06-10T23:24:09Z

You mentioned a content section as well, so I was running with it. Is this in the "beginner" or "easy" category,@bep? Maybe I can give it a shot 😄

digitalcraftsman · 2017-06-11T15:34:08Z

The general tenor of the comments seems to supports this proposal. I would to extend this thought by linking the files together as follows:

Hugo generates header.html and footer.html by default. So the baseof.html would look like this:

{{- partial "header.html" . -}}

{{- block "main" . }}{{- end }}

{{- partial "footer.html" . -}}

404.html, list.html, single.html and index.html would consist of

{{- define "main" }}{{- end }}

rdwatters · 2017-06-11T15:43:43Z

I would second the idea of including some partial calls as noted above by @digitalcraftsman. Simple enough to clue in new users and not so complicated that people end up deleting a bunch of scaffolding to get up and running...

bep · 2017-06-11T15:43:51Z

@digitalcraftsman I think the header/footer is an antipattern that the baseof.html solves -- and we should fix that. In the example you give, neither the header nor the footer is well-formed HTML document that can easily be edited/formatted by an editor. The baseof.html should form a simple and well formed HTML document with closing tags.

digitalcraftsman · 2017-06-11T16:14:18Z

@bep with my understanding of your comment you propose that baseof.html should contain the whole skeleton for a page, i.e. it "should form a simple and well formed HTML document with closing tags.".

Would a minimalistic baseof.html would look like this?

<html>
    <head>
        <title>Hugo</title>
        <!-- some other stuff -->
    </head>
    <body>
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>

        <footer>
            <!-- copyright etc. -->
        </footer>
    </body>
</html>

I see the inclusion of the header.html and footer.html in baseof.html as a composition of simple templates that form a larger and more complex one.

bep · 2017-06-11T16:46:16Z

The partial pattern is still useful and should still be part of the scheleton, as long as the templates are well formed:

<html>
    {{- partial "header.html" . -}}
    <body>
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>
        {{- partial "footer.html" . -}}
    </body>
</html>

Or variants of the above. In the above, all templates are well formed (base + footer + partial).

digitalcraftsman · 2017-06-11T16:48:22Z

Got it.

rdwatters · 2017-06-11T19:14:09Z

If I may get more granular, I would only suggest that there be a head.html and a header.html since head.html tends to get very big very quickly:

<html>
    <head>
    {{- partial "head.html" . -}}
    </head>
    <body>
        {{- partial "header.html" . -}}
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>
        {{- partial "footer.html" . -}}
    </body>
</html>

Anything more than this, though, and I'm probably just getting too opinionated 😄

bep · 2017-06-11T19:17:31Z

@rdwatters sure, but in your example head.html would not be well formed on its own.

bep · 2017-06-11T19:24:03Z

This would be a good start:

<html>
    {{- partial "head.html" . -}}
    <body>
        {{- partial "header.html" . -}}
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>
        {{- partial "footer.html" . -}}
    </body>
</html>

rdwatters · 2017-06-11T19:24:13Z

How about...

<html>
    {{- partial "head.html" . -}}
    <body>
        {{- partial "header.html" . -}}
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>
        {{- partial "footer.html" . -}}
    </body>
</html>

rdwatters · 2017-06-11T19:24:25Z

And we crossed streams. Oops.

stale · 2017-12-06T11:55:11Z

This issue has been automatically marked as stale because it has not had recent activity. The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.

anthonyfok · 2018-06-02T21:03:50Z

I got here from:

digitalcraftsman wrote:

But it would make sense to encourage theme creators to make use of baseof.html since it removes a lot of redundancy. Creating a baseof.html when executing hugo new theme xyz might also help to increase its adaption.

Sounds like a great idea!

Both bep and rdwatters wrote:

<html>
    {{- partial "head.html" . -}}
    <body>
        {{- partial "header.html" . -}}
        <div id="content">
        {{- block "main" . }}{{- end }}
        </div>
        {{- partial "footer.html" . -}}
    </body>
</html>

Hohoho! Great minds think alike!

Since everyone has come to a consensus, I think it would be interesting to implement it in hugo new theme and maybe even in hugo new site (in a new interactive mode) with more instruction and guidance to the person starting a new website or a new theme. With new theme especially, perhaps some guidance can ben written and some recommended licenses be offered...

@digitalcraftsman

Thanks to @digitalcraftsman, @bep and @rdwatters for providing the actual content of the default baseof.html file. Fixes gohugoio#3576

@digitalcraftsman

Thanks to @digitalcraftsman, @bep and @rdwatters for providing the actual content of the default baseof.html file. Fixes #3576

github-actions · 2022-03-03T01:59:20Z

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

digitalcraftsman added the Proposal label Jun 10, 2017

stale bot added the Stale label Dec 6, 2017

stale bot closed this as completed Dec 27, 2017

anthonyfok reopened this Jun 2, 2018

stale bot removed the Stale label Jun 2, 2018

anthonyfok self-assigned this Jun 2, 2018

anthonyfok added the Keep label Jun 5, 2018

anthonyfok added a commit to anthonyfok/hugo that referenced this issue Jun 11, 2018

commands: Create _default/baseof.html in "new theme"

bdaa62a

Thanks to @digitalcraftsman, @bep and @rdwatters for providing the actual content of the default baseof.html file. Fixes gohugoio#3576

anthonyfok mentioned this issue Jun 11, 2018

Tweak "new theme" and "new site" subcommands #4840

Merged

bep closed this as completed in #4840 Jun 11, 2018

bep pushed a commit that referenced this issue Jun 11, 2018

commands: Create _default/baseof.html in "new theme"

9717ac7

Thanks to @digitalcraftsman, @bep and @rdwatters for providing the actual content of the default baseof.html file. Fixes #3576

bep added this to the v0.42 milestone Jun 11, 2018

bep removed the Proposal label Jun 11, 2018

dependencies bot mentioned this issue Jun 12, 2018

Update https://github.com/gohugoio/hugo in repo_dependencies.yml from v0.41 to v0.42 matrixik/dobek.pro#18

Closed

github-actions bot added the Outdated label Mar 3, 2022

github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

hugo new theme does not create a baseof.html #3576

hugo new theme does not create a baseof.html #3576

juh2 commented Jun 10, 2017 •

edited by digitalcraftsman

Loading

digitalcraftsman commented Jun 10, 2017 •

edited

Loading

juh2 commented Jun 10, 2017 •

edited

Loading

bep commented Jun 10, 2017

rdwatters commented Jun 10, 2017

bep commented Jun 10, 2017

rdwatters commented Jun 10, 2017

digitalcraftsman commented Jun 11, 2017 •

edited

Loading

rdwatters commented Jun 11, 2017

bep commented Jun 11, 2017

digitalcraftsman commented Jun 11, 2017

bep commented Jun 11, 2017 •

edited

Loading

digitalcraftsman commented Jun 11, 2017

rdwatters commented Jun 11, 2017 •

edited

Loading

bep commented Jun 11, 2017 •

edited

Loading

bep commented Jun 11, 2017

rdwatters commented Jun 11, 2017

rdwatters commented Jun 11, 2017

stale bot commented Dec 6, 2017

anthonyfok commented Jun 2, 2018 •

edited

Loading

github-actions bot commented Mar 3, 2022

hugo new theme does not create a baseof.html #3576

hugo new theme does not create a baseof.html #3576

Comments

juh2 commented Jun 10, 2017 • edited by digitalcraftsman Loading

digitalcraftsman commented Jun 10, 2017 • edited Loading

juh2 commented Jun 10, 2017 • edited Loading

bep commented Jun 10, 2017

rdwatters commented Jun 10, 2017

bep commented Jun 10, 2017

rdwatters commented Jun 10, 2017

digitalcraftsman commented Jun 11, 2017 • edited Loading

rdwatters commented Jun 11, 2017

bep commented Jun 11, 2017

digitalcraftsman commented Jun 11, 2017

bep commented Jun 11, 2017 • edited Loading

digitalcraftsman commented Jun 11, 2017

rdwatters commented Jun 11, 2017 • edited Loading

bep commented Jun 11, 2017 • edited Loading

bep commented Jun 11, 2017

rdwatters commented Jun 11, 2017

rdwatters commented Jun 11, 2017

stale bot commented Dec 6, 2017

anthonyfok commented Jun 2, 2018 • edited Loading

github-actions bot commented Mar 3, 2022

juh2 commented Jun 10, 2017 •

edited by digitalcraftsman

Loading

digitalcraftsman commented Jun 10, 2017 •

edited

Loading

juh2 commented Jun 10, 2017 •

edited

Loading

digitalcraftsman commented Jun 11, 2017 •

edited

Loading

bep commented Jun 11, 2017 •

edited

Loading

rdwatters commented Jun 11, 2017 •

edited

Loading

bep commented Jun 11, 2017 •

edited

Loading

anthonyfok commented Jun 2, 2018 •

edited

Loading