From ca37d7488c726452739da68f9a096e0d8467d264 Mon Sep 17 00:00:00 2001 From: Alex Shpak Date: Wed, 12 Sep 2018 14:21:46 +0200 Subject: [PATCH] Fill theme.toml, refactor injection partials --- archetypes/default.md | 2 -- archetypes/docs.md | 4 ++++ layouts/docs/baseof.html | 12 +++++++----- layouts/docs/list.html | 8 +------- layouts/docs/single.html | 8 +------- layouts/partials/book/nav-bundle.html | 5 ----- layouts/partials/book/nav.html | 5 ----- layouts/partials/{book => docs}/html-head.html | 4 +--- .../html-head-after.html => docs/inject/body.html} | 0 .../{book/nav-after.html => docs/inject/head.html} | 0 .../nav-before.html => docs/inject/nav-after.html} | 0 layouts/partials/docs/inject/nav-before.html | 0 layouts/partials/{book => docs}/nav-brand.html | 0 layouts/partials/docs/nav-bundle.html | 8 ++++++++ layouts/partials/{book => docs}/nav-tree.html | 6 +++--- layouts/partials/docs/nav.html | 5 +++++ layouts/partials/{book => docs}/toc.html | 0 theme.toml | 10 +++++----- 18 files changed, 35 insertions(+), 42 deletions(-) delete mode 100644 archetypes/default.md create mode 100644 archetypes/docs.md delete mode 100644 layouts/partials/book/nav-bundle.html delete mode 100644 layouts/partials/book/nav.html rename layouts/partials/{book => docs}/html-head.html (81%) rename layouts/partials/{book/html-head-after.html => docs/inject/body.html} (100%) rename layouts/partials/{book/nav-after.html => docs/inject/head.html} (100%) rename layouts/partials/{book/nav-before.html => docs/inject/nav-after.html} (100%) create mode 100644 layouts/partials/docs/inject/nav-before.html rename layouts/partials/{book => docs}/nav-brand.html (100%) create mode 100644 layouts/partials/docs/nav-bundle.html rename layouts/partials/{book => docs}/nav-tree.html (92%) create mode 100644 layouts/partials/docs/nav.html rename layouts/partials/{book => docs}/toc.html (100%) diff --git a/archetypes/default.md b/archetypes/default.md deleted file mode 100644 index ac36e06..0000000 --- a/archetypes/default.md +++ /dev/null @@ -1,2 +0,0 @@ -+++ -+++ diff --git a/archetypes/docs.md b/archetypes/docs.md new file mode 100644 index 0000000..e215100 --- /dev/null +++ b/archetypes/docs.md @@ -0,0 +1,4 @@ +--- +title: "{{ .Name | humanize | title }}" +weight: 1 +--- diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 9f7f942..8509b14 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -1,25 +1,26 @@ - {{ partial "book/html-head" . }} - {{ block "title" . }}{{ .Site.Title }}{{ end }} + {{ partial "docs/html-head" . }} + {{ partial "docs/inject/head" . }} + {{ block "title" . }} {{- .Site.Title -}} {{ end }}
- {{ partial "book/nav" . }} + {{ partial "docs/nav" . }}
- {{ block "main" . }}{{ end }} + {{ block "main" . }} {{- .Content -}} {{ end }}
{{ if and (default true .Site.Params.BookShowTOC) (.Page.TableOfContents) }}
- {{ partial "book/toc" . }} + {{ partial "docs/toc" . }}
{{ end }} @@ -27,5 +28,6 @@
+ {{ partial "docs/inject/body" . }} \ No newline at end of file diff --git a/layouts/docs/list.html b/layouts/docs/list.html index 130cc89..a54943b 100644 --- a/layouts/docs/list.html +++ b/layouts/docs/list.html @@ -1,7 +1 @@ -{{- define "title" -}} - {{ .Site.Title }} -{{ end }} - -{{- define "main" -}} -
{{ .Content }}
-{{ end }} \ No newline at end of file +{{ define "." }} {{ end }} \ No newline at end of file diff --git a/layouts/docs/single.html b/layouts/docs/single.html index 130cc89..a54943b 100644 --- a/layouts/docs/single.html +++ b/layouts/docs/single.html @@ -1,7 +1 @@ -{{- define "title" -}} - {{ .Site.Title }} -{{ end }} - -{{- define "main" -}} -
{{ .Content }}
-{{ end }} \ No newline at end of file +{{ define "." }} {{ end }} \ No newline at end of file diff --git a/layouts/partials/book/nav-bundle.html b/layouts/partials/book/nav-bundle.html deleted file mode 100644 index 46665ad..0000000 --- a/layouts/partials/book/nav-bundle.html +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/layouts/partials/book/nav.html b/layouts/partials/book/nav.html deleted file mode 100644 index 929b1b7..0000000 --- a/layouts/partials/book/nav.html +++ /dev/null @@ -1,5 +0,0 @@ -{{ if .Site.Params.BookMenuBundle }} - {{ partial "book/nav-bundle" . }} -{{ else }} - {{ partial "book/nav-tree" . }} -{{ end }} \ No newline at end of file diff --git a/layouts/partials/book/html-head.html b/layouts/partials/docs/html-head.html similarity index 81% rename from layouts/partials/book/html-head.html rename to layouts/partials/docs/html-head.html index b171d7c..bf7db42 100644 --- a/layouts/partials/book/html-head.html +++ b/layouts/partials/docs/html-head.html @@ -6,6 +6,4 @@ {{ $styles := resources.Get "styles.scss" | resources.ToCSS | resources.Minify | resources.Fingerprint }} - - -{{ partial "book/html-head-after" . }} \ No newline at end of file + \ No newline at end of file diff --git a/layouts/partials/book/html-head-after.html b/layouts/partials/docs/inject/body.html similarity index 100% rename from layouts/partials/book/html-head-after.html rename to layouts/partials/docs/inject/body.html diff --git a/layouts/partials/book/nav-after.html b/layouts/partials/docs/inject/head.html similarity index 100% rename from layouts/partials/book/nav-after.html rename to layouts/partials/docs/inject/head.html diff --git a/layouts/partials/book/nav-before.html b/layouts/partials/docs/inject/nav-after.html similarity index 100% rename from layouts/partials/book/nav-before.html rename to layouts/partials/docs/inject/nav-after.html diff --git a/layouts/partials/docs/inject/nav-before.html b/layouts/partials/docs/inject/nav-before.html new file mode 100644 index 0000000..e69de29 diff --git a/layouts/partials/book/nav-brand.html b/layouts/partials/docs/nav-brand.html similarity index 100% rename from layouts/partials/book/nav-brand.html rename to layouts/partials/docs/nav-brand.html diff --git a/layouts/partials/docs/nav-bundle.html b/layouts/partials/docs/nav-bundle.html new file mode 100644 index 0000000..221325e --- /dev/null +++ b/layouts/partials/docs/nav-bundle.html @@ -0,0 +1,8 @@ + diff --git a/layouts/partials/book/nav-tree.html b/layouts/partials/docs/nav-tree.html similarity index 92% rename from layouts/partials/book/nav-tree.html rename to layouts/partials/docs/nav-tree.html index b87e944..6d0a2d5 100644 --- a/layouts/partials/book/nav-tree.html +++ b/layouts/partials/docs/nav-tree.html @@ -13,8 +13,8 @@ {{ end }} diff --git a/layouts/partials/docs/nav.html b/layouts/partials/docs/nav.html new file mode 100644 index 0000000..96bc233 --- /dev/null +++ b/layouts/partials/docs/nav.html @@ -0,0 +1,5 @@ +{{ if .Site.Params.BookMenuBundle }} + {{ partial "docs/nav-bundle" . }} +{{ else }} + {{ partial "docs/nav-tree" . }} +{{ end }} \ No newline at end of file diff --git a/layouts/partials/book/toc.html b/layouts/partials/docs/toc.html similarity index 100% rename from layouts/partials/book/toc.html rename to layouts/partials/docs/toc.html diff --git a/theme.toml b/theme.toml index f8b419e..6185172 100644 --- a/theme.toml +++ b/theme.toml @@ -3,13 +3,13 @@ name = "Book" license = "MIT" -licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE" -description = "" -homepage = "http://example.com/" -tags = [] +licenselink = "https://github.com/alex-shpak/hugo-book/blob/master/LICENSE" +description = "Hugo documentation theme as simple as plain book" +homepage = "https://github.com/alex-shpak/hugo-book" +tags = ["responsive", "clean", "documentation", "docs", "flexbox"] features = [] min_version = "0.41" [author] name = "Alex Shpak" - homepage = "" + homepage = "https://github.com/alex-shpak/"