From ca37d7488c726452739da68f9a096e0d8467d264 Mon Sep 17 00:00:00 2001 From: Alex Shpak Date: Wed, 12 Sep 2018 14:21:46 +0200 Subject: 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/html-head-after.html | 0 layouts/partials/book/html-head.html | 11 ----- layouts/partials/book/nav-after.html | 0 layouts/partials/book/nav-before.html | 0 layouts/partials/book/nav-brand.html | 3 -- layouts/partials/book/nav-bundle.html | 5 --- layouts/partials/book/nav-tree.html | 64 ---------------------------- layouts/partials/book/nav.html | 5 --- layouts/partials/book/toc.html | 1 - layouts/partials/docs/html-head.html | 9 ++++ layouts/partials/docs/inject/body.html | 0 layouts/partials/docs/inject/head.html | 0 layouts/partials/docs/inject/nav-after.html | 0 layouts/partials/docs/inject/nav-before.html | 0 layouts/partials/docs/nav-brand.html | 3 ++ layouts/partials/docs/nav-bundle.html | 8 ++++ layouts/partials/docs/nav-tree.html | 64 ++++++++++++++++++++++++++++ layouts/partials/docs/nav.html | 5 +++ layouts/partials/docs/toc.html | 1 + theme.toml | 10 ++--- 25 files changed, 108 insertions(+), 115 deletions(-) delete mode 100644 archetypes/default.md create mode 100644 archetypes/docs.md delete mode 100644 layouts/partials/book/html-head-after.html delete mode 100644 layouts/partials/book/html-head.html delete mode 100644 layouts/partials/book/nav-after.html delete mode 100644 layouts/partials/book/nav-before.html delete mode 100644 layouts/partials/book/nav-brand.html delete mode 100644 layouts/partials/book/nav-bundle.html delete mode 100644 layouts/partials/book/nav-tree.html delete mode 100644 layouts/partials/book/nav.html delete mode 100644 layouts/partials/book/toc.html create mode 100644 layouts/partials/docs/html-head.html create mode 100644 layouts/partials/docs/inject/body.html create mode 100644 layouts/partials/docs/inject/head.html create mode 100644 layouts/partials/docs/inject/nav-after.html create mode 100644 layouts/partials/docs/inject/nav-before.html create mode 100644 layouts/partials/docs/nav-brand.html create mode 100644 layouts/partials/docs/nav-bundle.html create mode 100644 layouts/partials/docs/nav-tree.html create mode 100644 layouts/partials/docs/nav.html create mode 100644 layouts/partials/docs/toc.html 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/html-head-after.html b/layouts/partials/book/html-head-after.html deleted file mode 100644 index e69de29..0000000 diff --git a/layouts/partials/book/html-head.html b/layouts/partials/book/html-head.html deleted file mode 100644 index b171d7c..0000000 --- a/layouts/partials/book/html-head.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - -{{ $styles := resources.Get "styles.scss" | resources.ToCSS | resources.Minify | resources.Fingerprint }} - - -{{ partial "book/html-head-after" . }} \ No newline at end of file diff --git a/layouts/partials/book/nav-after.html b/layouts/partials/book/nav-after.html deleted file mode 100644 index e69de29..0000000 diff --git a/layouts/partials/book/nav-before.html b/layouts/partials/book/nav-before.html deleted file mode 100644 index e69de29..0000000 diff --git a/layouts/partials/book/nav-brand.html b/layouts/partials/book/nav-brand.html deleted file mode 100644 index 5a2c9cb..0000000 --- a/layouts/partials/book/nav-brand.html +++ /dev/null @@ -1,3 +0,0 @@ -

- {{ .Site.Title }} -

\ 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-tree.html b/layouts/partials/book/nav-tree.html deleted file mode 100644 index b87e944..0000000 --- a/layouts/partials/book/nav-tree.html +++ /dev/null @@ -1,64 +0,0 @@ -{{ $bookSection := default "docs" .Site.Params.BookSection }} -{{ if eq $bookSection "*" }} - {{ .Scratch.Set "BookSections" .Site.Sections }} -{{ else }} - {{ $bookSections := where .Site.Sections "Section" $bookSection }} - {{ .Scratch.Set "BookSections" $bookSections }} - - {{ if eq (len $bookSections) 1 }} - {{ $singleSection := index $bookSections 0 }} - {{ .Scratch.Set "BookSections" $singleSection.Sections }} - {{ end }} - -{{ end }} - - - - -{{ define "book-section" }} -
  • - {{ template "book-heading" .Section }} - -
  • -{{ end }} - - -{{ define "book-heading" }} - -{{ $sections := split (trim .Dir "/") "/" }} -{{ $title := index ($sections | last 1) 0 | humanize | title }} -{{ $title := default .Title $title }} - -{{ if .Content }} - - {{- $title -}} - -{{ else }} - - {{- $title -}} - -{{ end }} - -{{ end }} 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/toc.html b/layouts/partials/book/toc.html deleted file mode 100644 index aca3785..0000000 --- a/layouts/partials/book/toc.html +++ /dev/null @@ -1 +0,0 @@ -{{ .Page.TableOfContents }} \ No newline at end of file diff --git a/layouts/partials/docs/html-head.html b/layouts/partials/docs/html-head.html new file mode 100644 index 0000000..bf7db42 --- /dev/null +++ b/layouts/partials/docs/html-head.html @@ -0,0 +1,9 @@ + + + + + + + +{{ $styles := resources.Get "styles.scss" | resources.ToCSS | resources.Minify | resources.Fingerprint }} + \ No newline at end of file diff --git a/layouts/partials/docs/inject/body.html b/layouts/partials/docs/inject/body.html new file mode 100644 index 0000000..e69de29 diff --git a/layouts/partials/docs/inject/head.html b/layouts/partials/docs/inject/head.html new file mode 100644 index 0000000..e69de29 diff --git a/layouts/partials/docs/inject/nav-after.html b/layouts/partials/docs/inject/nav-after.html new file mode 100644 index 0000000..e69de29 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/docs/nav-brand.html b/layouts/partials/docs/nav-brand.html new file mode 100644 index 0000000..5a2c9cb --- /dev/null +++ b/layouts/partials/docs/nav-brand.html @@ -0,0 +1,3 @@ +

    + {{ .Site.Title }} +

    \ No newline at end of file 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/docs/nav-tree.html b/layouts/partials/docs/nav-tree.html new file mode 100644 index 0000000..6d0a2d5 --- /dev/null +++ b/layouts/partials/docs/nav-tree.html @@ -0,0 +1,64 @@ +{{ $bookSection := default "docs" .Site.Params.BookSection }} +{{ if eq $bookSection "*" }} + {{ .Scratch.Set "BookSections" .Site.Sections }} +{{ else }} + {{ $bookSections := where .Site.Sections "Section" $bookSection }} + {{ .Scratch.Set "BookSections" $bookSections }} + + {{ if eq (len $bookSections) 1 }} + {{ $singleSection := index $bookSections 0 }} + {{ .Scratch.Set "BookSections" $singleSection.Sections }} + {{ end }} + +{{ end }} + + + + +{{ define "book-section" }} +
  • + {{ template "book-heading" .Section }} + +
  • +{{ end }} + + +{{ define "book-heading" }} + +{{ $sections := split (trim .Dir "/") "/" }} +{{ $title := index ($sections | last 1) 0 | humanize | title }} +{{ $title := default .Title $title }} + +{{ if .Content }} + + {{- $title -}} + +{{ else }} + + {{- $title -}} + +{{ end }} + +{{ 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/docs/toc.html b/layouts/partials/docs/toc.html new file mode 100644 index 0000000..aca3785 --- /dev/null +++ b/layouts/partials/docs/toc.html @@ -0,0 +1 @@ +{{ .Page.TableOfContents }} \ No newline at end of file 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/" -- cgit v1.2.3