kevin
/
basic-theme
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: kevin:v0.1.0
Branches Tags
kevin:master
kevin:v0.1.5
kevin:v0.1.4
kevin:v0.1.3
kevin:v0.1.2
kevin:v0.1.1
kevin:v0.1.0
...
compare: kevin:master
Branches Tags
kevin:master
kevin:v0.1.5
kevin:v0.1.4
kevin:v0.1.3
kevin:v0.1.2
kevin:v0.1.1
kevin:v0.1.0

15 Commits
v0.1.0 ... master

Author SHA1 Message Date
Kevin C. Coram 5f24758cbd
Fix instructions 2020-01-04 16:41:43 -05:00
Kevin C. Coram a34db13b72 Merge branch 'content-menu-docs' of kevin/basic-theme into master 2019-12-02 22:57:04 +00:00
Kevin C. Coram 689e69f0cf
Add documentation for content-menu block 2019-12-02 17:53:04 -05:00
Kevin C. Coram b0780f91e1
Update configuration docs section 
* Update `subtitle` documentation to note that HTML escape sequences are
restricted by the new Goldmark rendering engine
* Add documentation for the `mainSections` parameter
 2019-11-29 11:20:39 -05:00
Kevin C. Coram c9621cb516
Add a menu link back to the home page 2019-11-24 21:39:29 -05:00
Kevin C. Coram fddbc125f7
Document default content-footer 2019-11-24 16:55:37 -05:00
Kevin C. Coram f684465d00
Pagination for index, list, and single page layouts 2019-11-24 16:51:04 -05:00
Kevin C. Coram 3365dc074a
Add mainSections definition; set pagination to 5 2019-11-24 16:32:16 -05:00
Kevin C. Coram c6abdaefab
Add semantic HTML5 references 2019-11-23 14:44:32 -05:00
Kevin C. Coram 58b5a1ac96
Document Hugo templating approach 2019-11-23 14:33:41 -05:00
Kevin C. Coram ec18ebfeec
Add 'content-footer' block at end of main 2019-11-23 14:32:40 -05:00
Kevin C. Coram 24cf52e2e7
Add README file 
First version includes documentation for getting started and a basic
explanation of the theme's organization.
 2019-11-23 09:15:28 -05:00
Kevin C. Coram e5f250c91c
Move site title/sub-title into header partial 2019-11-22 23:29:39 -05:00
Kevin C. Coram 880e97f166 Merge branch 'semantics' of kevin/basic-theme into master 2019-11-21 04:52:01 +00:00
Kevin C. Coram 321fe23ea8
Move majority of semantic tags to baseof.html 
In order to improve the semantic layout of the page(s) in the site, the
bulk of the semantic elements have been explicitly moved to the baseof
file. Additional Hugo blocks have been defined to allow layouts to
supply or override things like section menus, the site menu, etc.
 2019-11-20 23:38:53 -05:00
12 changed files with 371 additions and 92 deletions
Show Stats Expand all files Collapse all files

209
README.md Normal file
View File

@ -0,0 +1,209 @@
# A Basic Hugo Theme
While the official documentation about Hugo [Templates](https://gohugo.io/templates/)
does provide all of the pieces to get started creating a theme, it doesn't
necessarily put them together in one, easy-to-see-together place. This theme
attempts to pull all of the necessary pieces together into a theme that can be
used as a starting point to create more sophisticated themes.
## Getting Started
Follow the [Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
instructions on how to install Hugo, create a site, and install a theme.
Installing the theme as a git submodule is the preferred way.
```
git submodule add https://git.thecorams.net/kevin/basic-theme.git themes/basic-theme
```
### Example Site
The theme includes an example site to give a quick way to see how the theme
looks and behaves.
```
cd exampleSite
hugo serve [ -D ] --themesDir ../..
```
Most of the sample posts are intentionally set `draft: true` to allow for
testing few posts vs many posts.
## Configuration
As a very basic theme, there is very little to be configured via the `config.toml`
file.
The footer layout file uses Hugo's `markdownify` pipe to display the `copyright`
configuration setting, providing support both for HTML character escape
sequences such as `©` as well as markdwn formatting and links.
Note: Hugo versions 0.60.0 and up will have restrictions on using embedded HTML,
including escape secquences, unless the Goldmark renderer is configure with
`unsafe = true`.
### `subtitle` parameter
Setting the `subtitle` parameter adds a secondary header underneath the `title`
in the site header.
```toml
[params]
subtitle = "A sub-title for your site"
```
### `mainSections` parameter
Setting the `mainSections` parameter restricts the pages that appear on the
homepage.
```toml
[params]
mainSections = ["posts"]
```
## Theme Organization
### Semantic Content Organization
The chrome of the theme page organization is as follows:
```html
<html>
<head>
<title>Site Title</title>
</head>
<body>
<header>
<hgroup>
<h1>Site Title</h1>
<h2>Site Sub-title</h2>
</hgroup>
<nav>
<!-- Site Navigation/Menu: links to pages that are part of -->
<!-- the "main" menu -->
</nav>
</header>
<main>
<header>
<h1>Content Title</h1>
<nav>
<!-- Content Navigation/Menu: a place holder for a -->
<!-- content specific menu, such as a list of blog posts -->
<!-- based on publication date. Not yet implemented. -->
</nav>
</header>
<section>
<!-- The page content. For list sections, this is where the -->
<!-- the list of pages goes. For single pages, this is where -->
<!-- the content of the page markdown file goes. -->
</section>
<footer>
<!-- The page footer. For list sections, this is where the -->
<!-- pagination controls can go. For single pages, this is -->
<!-- where auther attribution and/or prev/next page controls -->
<!-- could go. -->
</footer>
</main>
<footer>
<!-- The Site Footer, for copyright information etc. -->
</footer>
</body>
</html>
```
If the content pages use `##` as their largest heading, this will result
in document outlines structured as:
1. Site Title
1. Site Sub-title
2. Content Title
1. Header from Content
1. Sub-header from content
2. Second Header from Content
### Hugo Templating
The template layout files make heavy use of Hugo's
[base and block constructs](https://gohugo.io/templates/base/), as can be seen
in [baseof.html](layouts/_default/baseof.html).
#### title
This block is used for generating the `<title>....</title>` markup for the
rendered page and defaults to using the `title` configuration from `comfig.toml`.
The [list](layouts/_default/list.html) and [single](layouts/_default/single.html)
templates add the page title, to facilitate generating a unique title for every
page.
#### site-header
This block is for providing a site banner that will appear at the top of every page,
and matches with the primary `<header>...</header>` definition from the semantic
organization, above.
The default site-header block displays the [header.html](layouts/partials/header.html)
partial.
#### site-menu
This block is for providing a site-level navigation, which also appears at the
top of every page. It renders in the `<nav>...</nav>` block within the primary
header.
The default site-meny block displays the [site-menu](layouts/partials/site-menu.html)
partial.
#### content-header
This block is for providing a header for the specific page, matching with the
header block inside the `<main>....<\main>` definition from the semantic
organization. The [list](layouts/_default/list.html) and
[single](layouts/_default/single.html) templates display the page title as
a `<h1>...</h1>` level header.
#### content-menu
This block is for providing navigation menu(s) for the main content, matching
with the `<nav>...</nav>` block inside the main header. The block is currently
a place holder, with no default implementation.
#### content
This block is for the content of the page.
For [list](layouts/_default/list.html) pages, the content from the section's
`_index.md` will be rendered, followed by a list of all of the pages within
the section, using the [summary](layouts/_default/summary.html) template.
For [single](layouts/_default/single.html) pages, the page content will be
rendered inside an `<article>...</article>` block element.
#### content-footer
This block provides a footer for the page, which renders within the
`<footer></footer>` block at the end of the `<main></main>` section.
The default content-footer blocks for the homepage and for list pages
implement pagination controls to show the content summaries a page at a time.
The default content-footer block for single pages displays previous and/or
next in section links.
#### footer
This block is for the site footer that appears at the end of every pages.
The default footer block displays the [footer.html](layouts/partials/footer.html)
partial.
## References
### HTML5 Semantics
- [Semantic HTML](https://internetingishard.com/html-and-css/semantic-html/)
- [HTML5 Semantic Elements](https://guide.freecodecamp.org/html/html5-semantic-elements/)
- [A Look Into Proper HTML5 Semantics](https://www.hongkiat.com/blog/html-5-semantics/amp/)
- [HTML5 Semantic Tags: What Are They & How To Use Them! - SEMrush](https://www.semrush.com/blog/semantic-html5-guide/)

3
exampleSite/config.toml
View File

@ -3,10 +3,11 @@ languageCode = "en-us"
title = "Basic Hugo Theme" title = "Basic Hugo Theme"
copyright = "Copyright &copy; 2019, Copyright Owner Name | Built with [Hugo](https://gohugo.io/)" copyright = "Copyright &copy; 2019, Copyright Owner Name | Built with [Hugo](https://gohugo.io/)"
theme = "basic-theme" theme = "basic-theme"
paginate = 10 paginate = 5
[permalinks] [permalinks]
posts = "/:year/:month/:title/" posts = "/:year/:month/:title/"
[params] [params]
subtitle = "A theme with no CSS and only basic layouts" subtitle = "A theme with no CSS and only basic layouts"
mainSections = [ "posts" ]

40
layouts/_default/baseof.html
View File

@ -4,22 +4,48 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ block "title" . }} <title>{{- block "title" . -}}
{{ .Site.Title }} {{ .Site.Title }}
{{ end }}</title> {{- end -}}</title>
</head> </head>
<body> <body>
<header>
{{- block "site-header" . -}}
<!-- Code that all your templates share, like a header --> <!-- Code that all your templates share, like a header -->
{{ partial "header.html" . }} {{ partial "header.html" . }}
{{ block "main" . }} {{- end }}
<nav>
{{ block "site-menu" . -}}
{{ partial "site-menu.html" . }}
{{- end }}
</nav>
</header>
<main>
<header>
{{- block "content-header" . -}}
{{- end -}}
<nav>
{{- block "content-menu" . -}}
{{- end -}}
</nav>
</header>
<section>
{{- block "content" . -}}
<!-- The part of the page that begins to differ between templates --> <!-- The part of the page that begins to differ between templates -->
{{ end }} {{ end }}
{{ block "footer" . }} </section>
<footer>
{{- block "content-footer" . -}}
{{- end -}}
</footer>
</main>
<footer>
{{- block "footer" . -}}
<!-- More shared code, perhaps a footer but that can be overridden if need be in --> <!-- More shared code, perhaps a footer but that can be overridden if need be in -->
{{ partial "footer.html" . }} {{- partial "footer.html" . -}}
{{ end }} {{- end -}}
</footer>
</body> </body>
</html> </html>

29
layouts/_default/list.html
View File

@ -2,18 +2,19 @@
{{ define "title" }} {{ define "title" }}
{{ .Title }} &ndash; {{ .Site.Title }} {{ .Title }} &ndash; {{ .Site.Title }}
{{ end }} {{ end }}
{{ define "main" }} {{ define "content-header" }}
<main> <h1 id="title">{{ .Title }}</h1>
<div> {{ end }}
<h1 id="title">{{ .Title }}</h1> {{ define "content" }}
<div class="list-content"> <header class="list-content">
{{ .Content }} {{ .Content }}
</div> </header>
<div class="list-summary"> {{ range $index, $page := (.Paginate (where .Pages ".Params.hidden" "!=" "true")).Pages }}
{{ range .Pages }} {{ if ne $index 0 }}
{{ .Render "summary"}} {{ end }}
{{ end }} {{ .Render "summary" }}
</div> {{ end }}
</div> {{ end }}
</main> {{ define "content-footer" }}
{{ partial "paginator.html" .Paginator }}
{{ end }} {{ end }}

15
layouts/_default/single.html
View File

@ -2,9 +2,14 @@
{{ define "title" }} {{ define "title" }}
{{ .Title }} &ndash; {{ .Site.Title }} {{ .Title }} &ndash; {{ .Site.Title }}
{{ end }} {{ end }}
{{ define "main" }} {{ define "content-header" }}
<main> <h1>{{ .Title }}</h1>
<h1>{{ .Title }}</h1> {{ end }}
{{ .Content }} {{ define "content" }}
</main> <article>
{{ .Content }}
</article>
{{ end }}
{{ define "content-footer" }}
{{ partial "prev-next-page.html" . }}
{{ end }} {{ end }}

6
layouts/_default/summary.html
View File

@ -3,12 +3,14 @@
<h2><a href='{{ .Permalink }}'>{{ .Title }}</a> </h2> <h2><a href='{{ .Permalink }}'>{{ .Title }}</a> </h2>
<div class="post-meta">{{ .Date.Format "Mon, Jan 2, 2006" }} - {{ .FuzzyWordCount }} Words </div> <div class="post-meta">{{ .Date.Format "Mon, Jan 2, 2006" }} - {{ .FuzzyWordCount }} Words </div>
</header> </header>
<section>
{{ .Summary }} {{ .Summary }}
{{ if .Truncated }} </section>
{{- if .Truncated }}
<footer> <footer>
<a href='{{ .Permalink }}'> <a href='{{ .Permalink }}'>
<span style="white-space: nowrap;">Read more →</span> <span style="white-space: nowrap;">Read more →</span>
</a> </a>
</footer> </footer>
{{ end }} {{- end }}
</article> </article>

31
layouts/index.html
View File

@ -1,22 +1,15 @@
{{ define "main" }} {{ define "content" }}
<main> <article class="homepage-content">
<header class="homepage-header">
<h1>{{.Title}}</h1>
{{ if .Params.Subtitle }}
<span class="subtitle">{{.Params.Subtitle}}</span>
{{ else if .Site.Params.Subtitle }}
<span class="subtitle">{{.Site.Params.Subtitle}}</span>
{{ end }}
</header>
<div class="homepage-content">
<!-- Note that the content for index.html, as a sort of list page, will pull from content/_index.md --> <!-- Note that the content for index.html, as a sort of list page, will pull from content/_index.md -->
{{.Content}} {{.Content}}
</div> </article>
<div> <!-- Note that .Pages is the same as .Site.RegularPages on the homepage template. -->
<!-- Note that .Pages is the same as .Site.RegularPages on the homepage template. --> {{ range $index, $page := (.Paginate (where (where .Site.RegularPages "Type" "in" site.Params.mainSections) ".Params.hidden" "!=" "true" )).Pages }}
{{ range first 10 .Pages }} {{ if ne $index 0 }}
{{ .Render "summary"}} {{ end }}
{{ end }} {{ .Render "summary" }}
</div> {{ end }}
</main> {{ end }}
{{ define "content-footer" }}
{{ partial "paginator.html" .Paginator }}
{{ end }} {{ end }}

8
layouts/partials/footer.html
View File

@ -1,5 +1,3 @@
<footer> {{ with .Site.Copyright }}
{{ with .Site.Copyright }} <p class="copyright">{{ . | markdownify }}</p>
<p class="copyright">{{ . | markdownify }}</p> {{ end }}
{{ end }}
</footer>

37
layouts/partials/header.html
View File

@ -1,31 +1,6 @@
<header> <hgroup>
<nav> <h1>{{.Site.Title}}</h1>
<ul> {{- if .Site.Params.Subtitle }}
{{ $currentPage := . }} <h2 class="subtitle">{{.Site.Params.Subtitle}}</h2>
{{ range .Site.Menus.main }} {{- end }}
{{ if .HasChildren }} </hgroup>
<li class="{{ if $currentPage.HasMenuCurrent "main" . }}active{{ end }}">
<a href="#">
{{ .Pre }}
<span>{{ .Name }}</span>
</a>
</li>
<ul class="sub-menu">
{{ range .Children }}
<li class="{{ if $currentPage.IsMenuCurrent "main" . }}active{{ end }}">
<a href="{{ .URL }}">{{ .Name }}</a>
</li>
{{ end }}
</ul>
{{ else }}
<li>
<a href="{{ .URL }}">
{{ .Pre }}
<span>{{ .Name }}</span>
</a>
</li>
{{ end }}
{{ end }}
</ul>
</nav>
</header>

19
layouts/partials/paginator.html Normal file
View File

@ -0,0 +1,19 @@
<nav>
<ul>
<li>
{{if .HasPrev}}
<a alt="Newer articles" href="{{ .Prev.URL }}">&larr; Newer</a>
{{ else }}
&nbsp;
{{end}}
</li>
<li>Page {{ .PageNumber }} of {{ .TotalPages }}</li>
<li>
{{if .HasNext}}
<a alt="Older articles" href="{{ .Next.URL }}">Older &rarr;</a>
{{ else }}
&nbsp;
{{end}}
</li>
</ul>
</nav>

20
layouts/partials/prev-next-page.html Normal file
View File

@ -0,0 +1,20 @@
{{ if not .Params.Menu }}
<nav>
<ul>
<li>
{{ if .NextInSection }}
<a alt="Newer article" href="{{ .NextInSection.Permalink }}">&larr; Newer</a>
{{ else }}
&nbsp;
{{ end }} </li>
<li><a alt="Top of page" href="#">Top</a></li>
<li>
{{ if .PrevInSection }}
<a alt="Older article" href="{{ .PrevInSection.Permalink }}">Older &rarr;</a>
{{ else }}
&nbsp;
{{ end }}
</li>
</ul>
</nav>
{{ end }}

30
layouts/partials/site-menu.html Normal file
View File

@ -0,0 +1,30 @@
<ul>
{{ if not .IsHome }}
<li><a href="{{ .Site.BaseURL }}">Home</a></li>
{{ end }}
{{- $currentPage := . -}}
{{- range .Site.Menus.main -}}
{{- if .HasChildren -}}
<li class="{{ if $currentPage.HasMenuCurrent "main" . }}active{{ end }}">
<a href="#">
{{ .Pre }}
<span>{{ .Name }}</span>
</a>
</li>
<ul class="sub-menu">
{{ range .Children }}
<li class="{{ if $currentPage.IsMenuCurrent "main" . }}active{{ end }}">
<a href="{{ .URL }}">{{ .Name }}</a>
</li>
{{ end }}
</ul>
{{ else }}
<li>
<a href="{{ .URL }}">
{{ .Pre }}
<span>{{ .Name }}</span>
</a>
</li>
{{- end -}}
{{ end }}
</ul>