Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/tastaturtier/someparts-hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSandro Leuchter <sandro.leuchter@dama.io>2020-02-12 13:15:49 +0300
committerSandro Leuchter <sandro.leuchter@dama.io>2020-02-12 13:15:49 +0300
commitec9de32ce04f576e8a1c20e62cebb5445b338678 (patch)
tree9411bb559a85d2f1dba21ea6e6630432f4b8b7da
parent737e72b9e51d5d5dc161049e848bc56e198adc5e (diff)
extension: part does not have to be in a bundle but can also be a single page (see exampleSite/content/blue.md)
-rw-r--r--README.md66
-rw-r--r--exampleSite/content/blue.md31
-rw-r--r--exampleSite/content/orange/_index.md2
-rw-r--r--layouts/part/list.html29
-rw-r--r--layouts/part/single.html4
-rw-r--r--layouts/partials/part.html27
6 files changed, 121 insertions, 38 deletions
diff --git a/README.md b/README.md
index e289929..dd89c6b 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,10 @@
Minimalistic Hugo theme to present some parts of a collection.
-## Demo
+## Demos
-https://someparts-hugo.netlify.com/
+- https://someparts-hugo.netlify.com/
+- https://verteiltearchitekturen.de/
## Minimum Hugo version
@@ -40,15 +41,60 @@ hugo server --themesDir ../..
Copy the `config.toml` from the [`exampleSite`](https://github.com/tastaturtier/someparts-hugo/tree/master/exampleSite), then edit as desired.
-## Override
-
-The ``someparts-hugo``-Theme is made to present parts of a collection. The [`exampleSite`](https://github.com/tastaturtier/someparts-hugo/tree/master/exampleSite) has some colors as part of a palette. The actual usecase ``someparts-hugo`` was made is to present volumes of a book series. It would be easily possible to make it chapters of a book instead.
-
-## Part (e.g. ``/orange/_index.md``)
-### Icon in front of part-elements
-## Ressource (e.g. ``/orange/something.md``)
-``_default`` (``single.html``)
## The Collection (``/_index.md``)
``_default`` (``list.html``)
## Menu (Drop Down)
+## Icon in front of part-elements
+
+The ``someparts-hugo``-Theme is made to present parts of a collection. The [`exampleSite`](https://github.com/tastaturtier/someparts-hugo/tree/master/exampleSite) has some colors as part of a palette. The actual usecase for which ``someparts-hugo`` was made is to [present volumes of a book series](https://verteiltearchitekturen.de/). It would be easy to adapt it to chapters of a book instead.
+
+## Part (e.g. ``/orange/_index.md``, ``/blue.md``)
+
+Parts
+
+This theme presents a collection of some (not too many) parts. Each part has the following meta-data that can be set in the front matter :
+
+- **``id``**: a short name for this part to be used in the top menu and in the collection's main list view.
+- **``subtitle``** [*optional*]: An optional subtitle that is only displayed on this part's main page.
+- **``cover.img``**:
+- **``cover.link``** [*optional*] *(format: a URL, can be relative to this part's directory):
+- **``link.url``** [*optional together with link.linktext*] *(format: a URL, can be relative to this part's directory):
+- **``link.linktext``** [*optional together with link.url*] :
+
+The following of the predefined front matter variables are suported:
+
+- **``title``**: The title of the part that is used as the ``<h1>`` element of this part's main page as well as in the collection's main list view.
+- **``aliases``** [*optional*] *(format: path)*:
+- **``audio``** [*optional*]:
+- **``cascade``** [*optional*]:
+- **``date``** [*optional*] *(format: ``2019-12-31``)*:
+- **``description``**:
+- **``draft``** [*optional*]:
+- **``expiryDate
+- **``headless
+- **``isCJKLanguage
+- **``keywords``**:
+- **``lastmod
+- **``publishDate
+- **``slug
+- **``type
+- **``url
+- **``weight``**: a number that controls the order of parts in the top menu and in the collection's main list view. *Smaller* weights are *more left* in the menu and *more above* in the collection's main list view.
+
+not supported:
+
+- **``images
+- **``layout
+- **``linkTitle
+- **``markup
+- **``outputs
+- **``resources
+- **``series
+- **``summary
+- **``videos
+- **``tags
+- **``categories
+
+## Ressource (e.g. ``/orange/something.md``)
+``_default`` (``single.html``)
## Cookie Consent / Google Analytics
diff --git a/exampleSite/content/blue.md b/exampleSite/content/blue.md
new file mode 100644
index 0000000..97f4fa0
--- /dev/null
+++ b/exampleSite/content/blue.md
@@ -0,0 +1,31 @@
+---
+type: part
+id: Blue
+weight: 20
+title: a further title on blue things
+keywords: ink, sky
+description: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+
+Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.
+
+
+Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi."
+link:
+ url: https://commons.wikimedia.org/wiki/File:Mandarin_Oranges_(Citrus_Reticulata).jpg
+ linktext: Foto by Joe Ravi [CC BY-SA (https://creativecommons.org/licenses/by-sa/3.0)]
+cover:
+ img: /orange/orange.jpg
+---
+
+## section 1
+
+Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.
+
+Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis.
+
+## section 2
+
+At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, At accusam aliquyam diam diam dolore dolores duo eirmod eos erat, et nonumy sed tempor et et invidunt justo labore Stet clita ea et gubergren, kasd magna no rebum. sanctus sea sed takimata ut vero voluptua. est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.
+
+Consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. \ No newline at end of file
diff --git a/exampleSite/content/orange/_index.md b/exampleSite/content/orange/_index.md
index 8b91f93..a413d9b 100644
--- a/exampleSite/content/orange/_index.md
+++ b/exampleSite/content/orange/_index.md
@@ -6,8 +6,10 @@ title: Orange -- the color of oranges and peaches
keywords: orange, peach, orange, tanerine, ...
description: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.
+
Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi."
link:
url: https://commons.wikimedia.org/wiki/File:Mandarin_Oranges_(Citrus_Reticulata).jpg
diff --git a/layouts/part/list.html b/layouts/part/list.html
index 497898a..9bf6d8c 100644
--- a/layouts/part/list.html
+++ b/layouts/part/list.html
@@ -1,33 +1,6 @@
{{- define "main" -}}
-<h1>{{ .Title | markdownify }}</h1>
-<p><a href="../">{{ .Site.Params.title | markdownify }}</a>, {{ .Params.id | markdownify }}</p>
-<p><em>{{ .Params.subtitle | markdownify }}</em></p>
-<hr/>
-<div class="container">
- <div class="row">
- <div class="col-sm-9">
- {{ with .Params.description }}
- {{ . | markdownify }}
- {{ end }}
- {{ with .Params.link }}
- <nav class="nav flex-column">
- <a href="{{ .url }}"><i class='fa fa-bookmark' aria-hidden='true'></i> {{ .linktext | markdownify }}</a>
- </nav>
- {{ end }}
- </div>
- {{ with .Params.cover }}
- <div class="col-sm-3">
- <p>{{ if .link }}<a href="{{ .link }}">{{ end }}<img src="{{ .img }}" alt="Cover" />{{ if .link }}</a>{{ end }}</p>
- </div>
- {{ end }}
- </div>
-</div>
-{{ if .Content }}
-<hr/>
-{{ end }}
-{{ .Content }}
-
+{{ partial "part.html" . }}
{{ if .Pages }}
<hr/>
{{ end }}
diff --git a/layouts/part/single.html b/layouts/part/single.html
new file mode 100644
index 0000000..f072479
--- /dev/null
+++ b/layouts/part/single.html
@@ -0,0 +1,4 @@
+{{- define "main" -}}
+
+{{ partial "part.html" . }}
+{{- end -}} \ No newline at end of file
diff --git a/layouts/partials/part.html b/layouts/partials/part.html
new file mode 100644
index 0000000..4351cca
--- /dev/null
+++ b/layouts/partials/part.html
@@ -0,0 +1,27 @@
+<h1>{{ .Title | markdownify }}</h1>
+<p><a href="../">{{ .Site.Params.title | markdownify }}</a>, {{ .Params.id | markdownify }}</p>
+<p><em>{{ .Params.subtitle | markdownify }}</em></p>
+<hr/>
+<div class="container">
+ <div class="row">
+ <div class="col-sm-9">
+ {{ with .Params.description }}
+ {{ . | markdownify }}
+ {{ end }}
+ {{ with .Params.link }}
+ <nav class="nav flex-column">
+ <a href="{{ .url }}"><i class='fa fa-bookmark' aria-hidden='true'></i> {{ .linktext | markdownify }}</a>
+ </nav>
+ {{ end }}
+ </div>
+ {{ with .Params.cover }}
+ <div class="col-sm-3">
+ <p>{{ if .link }}<a href="{{ .link }}">{{ end }}<img src="{{ .img }}" alt="Cover" />{{ if .link }}</a>{{ end }}</p>
+ </div>
+ {{ end }}
+ </div>
+</div>
+{{ if .Content }}
+<hr/>
+{{ end }}
+{{ .Content }}