mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-02-07 12:23:30 +00:00
Merge pull request #36 from lierdakil/use-index-pages
Use index pages + automatic navigation arrows
This commit is contained in:
Mathieu Cornic
GitHub
commit
460f0365d1
7 changed files with 108 additions and 45 deletions
|
|
@ -1,9 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Some Chapter title"
|
title: "Some Chapter title"
|
||||||
weight: 0
|
weight: 0
|
||||||
prev: /prev/path
|
|
||||||
next: /next/path
|
|
||||||
chapter: true
|
|
||||||
icon: "<b>X. </b>" # HTML code as prefix in the menu
|
icon: "<b>X. </b>" # HTML code as prefix in the menu
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Some Title"
|
title: "Some Title"
|
||||||
weight: 5
|
weight: 5
|
||||||
prev: /prev/path
|
|
||||||
next: /next/path
|
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
{{ if .Content }}
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
{{ .Content }}
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
{{ else }}
|
||||||
|
{{ with (index (index .Site.Sections .Section) 0) }}
|
||||||
|
{{ with .Page }}
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
{{ .Content }}
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
|
@ -1,14 +1,54 @@
|
||||||
|
|
||||||
{{ if .Params.chapter }}
|
{{ $isChapter := .Params.chapter | default (eq .Kind "section")}}
|
||||||
|
{{ if $isChapter }}
|
||||||
</div> <!-- end chapter-->
|
</div> <!-- end chapter-->
|
||||||
{{ end }}
|
{{ end }}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{{ if $.Site.Params.autoNav }}
|
||||||
|
{{ $.Scratch.Set "_sectionpages" (slice) }}
|
||||||
|
{{ if $.Site.Params.menu }}
|
||||||
|
{{ range $sname := $.Site.Params.menu }}
|
||||||
|
{{ $.Scratch.Add "_sectionpages" ($.Site.GetPage "section" $sname) }}
|
||||||
|
{{ end }}
|
||||||
|
{{ else }}
|
||||||
|
{{ range $sname, $spages := .Site.Sections }}
|
||||||
|
{{ $.Scratch.Add "_sectionpages" ($.Site.GetPage "section" $sname) }}
|
||||||
|
{{ end }}
|
||||||
|
{{ $.Scratch.Set "_sectionpages" (sort ($.Scratch.Get "_sectionpages") "Weight") }}
|
||||||
|
{{ end }}
|
||||||
|
{{ $.Scratch.Set "_allpages" (slice) }}
|
||||||
|
{{ range $.Scratch.Get "_sectionpages" }}
|
||||||
|
{{ if .Content }}
|
||||||
|
{{ $.Scratch.Add "_allpages" . }}
|
||||||
|
{{ end }}
|
||||||
|
{{ range index $.Site.Sections .Section }}
|
||||||
|
{{ $.Scratch.Add "_allpages" .Page }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
{{ $Site := .Site }}
|
{{ if $.Site.Params.autoNav }}
|
||||||
{{ with .Params.prev }}<a class="nav nav-prev" href="{{ $Site.BaseURL }}{{ . }}"> <i class="fa fa-chevron-left"></i></a>{{ end }}
|
{{ $allpages := $.Scratch.Get "_allpages" }}
|
||||||
{{ with .Params.next }}<a class="nav nav-next" href="{{ $Site.BaseURL }}{{ . }}" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>{{ end }}
|
{{ range $index, $element := $allpages }}
|
||||||
|
{{if eq $element.UniqueID $.UniqueID }}
|
||||||
|
{{ if not (isset $.Params "prev") }}
|
||||||
|
{{ with index $allpages (sub $index 1) }}
|
||||||
|
<a class="nav nav-prev" href="{{ .URL }}"> <i class="fa fa-chevron-left"></i></a>
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ if not (isset $.Params "next") }}
|
||||||
|
{{ with index $allpages (add $index 1) }}
|
||||||
|
<a class="nav nav-next" href="{{ .URL }}" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
{{ with .Params.prev }}<a class="nav nav-prev" href="{{ . | relURL }}"> <i class="fa fa-chevron-left"></i></a>{{ end }}
|
||||||
|
{{ with .Params.next }}<a class="nav nav-next" href="{{ . | relURL }}" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>{{ end }}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@
|
||||||
{{ partial "style.html" . }}
|
{{ partial "style.html" . }}
|
||||||
</head>
|
</head>
|
||||||
<body class="" data-url="{{ .RelPermalink }}">
|
<body class="" data-url="{{ .RelPermalink }}">
|
||||||
|
{{ $isChapter := .Params.chapter | default (eq .Kind "section")}}
|
||||||
{{ partial "menu.html" . }}
|
{{ partial "menu.html" . }}
|
||||||
<section id="body">
|
<section id="body">
|
||||||
<div id="overlay"></div>
|
<div id="overlay"></div>
|
||||||
|
|
@ -47,15 +48,20 @@
|
||||||
<i class="fa fa-bars"></i>
|
<i class="fa fa-bars"></i>
|
||||||
</a>
|
</a>
|
||||||
</span>
|
</span>
|
||||||
{{ if and (not .Params.chapter) (.Params.toc) }}
|
{{ if and (not $isChapter) (.Params.toc) }}
|
||||||
<span id="toc-menu"><a href=""><i class="fa fa-list-alt"></i></a></span>
|
<span id="toc-menu"><a href=""><i class="fa fa-list-alt"></i></a></span>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ $type := .Type }}
|
{{ if ne $.Section "" }}
|
||||||
{{ $relLink := .RelPermalink }}
|
{{ $section := index $.Site.Sections $.Section }}
|
||||||
{{ range $name , $value := .Site.Sections }}
|
{{ $sectionPage := $.Site.GetPage "section" $.Section }}
|
||||||
{{ if eq $name $type }}
|
{{ if $sectionPage.Content }}
|
||||||
{{ $first := (index $value 0).Page }}
|
{{ $first := $.Site.GetPage "section" $.Section }}
|
||||||
{{ if ne $first.RelPermalink $relLink }}
|
{{ if ne $first.UniqueID $.UniqueID }}
|
||||||
|
<a href="{{ $first.RelPermalink }}" itemprop="url"><span itemprop="title">{{ $first.Title }}</span></a> <i class="fa fa-angle-right"></i>
|
||||||
|
{{ end }}
|
||||||
|
{{ else if gt $section.Len 0 }}
|
||||||
|
{{ $first := (index $section 0).Page }}
|
||||||
|
{{ if ne $first.UniqueID $.UniqueID }}
|
||||||
<a href="{{ $first.RelPermalink }}" itemprop="url"><span itemprop="title">{{ $first.Title }}</span></a> <i class="fa fa-angle-right"></i>
|
<a href="{{ $first.RelPermalink }}" itemprop="url"><span itemprop="title">{{ $first.Title }}</span></a> <i class="fa fa-angle-right"></i>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
@ -67,10 +73,10 @@
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
{{ if .Params.chapter }}
|
{{ if $isChapter }}
|
||||||
<div id="chapter">
|
<div id="chapter">
|
||||||
{{ end }}
|
{{ end }}
|
||||||
<div id="body-inner">
|
<div id="body-inner">
|
||||||
{{ if not .Params.chapter }}
|
{{ if not $isChapter }}
|
||||||
<h1>{{.Title}}</h1>
|
<h1>{{.Title}}</h1>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
|
||||||
|
|
@ -11,56 +11,65 @@
|
||||||
|
|
||||||
<div class="highlightable">
|
<div class="highlightable">
|
||||||
<ul class="topics">
|
<ul class="topics">
|
||||||
{{ $page := . }}
|
{{ if $.Site.Params.menu }}
|
||||||
{{ if .Site.Params.menu }}
|
{{ $.Scratch.Set "menuItems" $.Site.Params.menu }}
|
||||||
{{ $.Scratch.Set "menuItems" (slice) }}
|
{{ else }}
|
||||||
{{ range $i, $key := .Site.Params.menu }}
|
{{ $.Scratch.Set "_pages" (slice) }}
|
||||||
{{ if isset $page.Site.Sections $key }}
|
{{ range $key, $value := .Site.Sections }}
|
||||||
{{ $.Scratch.Add "menuItems" $key }}
|
{{ $sectionPage := $.Site.GetPage "section" $key }}
|
||||||
{{ else }}
|
{{ if $sectionPage.Content }}
|
||||||
<li class="dd-item"><div class="notices warning"><p>
|
{{ $.Scratch.Add "_pages" $sectionPage }}
|
||||||
{{ printf "Unknown section '%s' found in site menu" $key }}
|
{{ else if gt $value.Len 0 }}
|
||||||
</p></div></li>
|
{{ $.Scratch.Add "_pages" (index $value 0).Page }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ else }}
|
{{ $.Scratch.Set "menuItems" (slice)}}
|
||||||
{{ $.Scratch.Set "menuItems" .Site.Sections }}
|
{{ range $key, $value := sort ($.Scratch.Get "_pages") "Weight" }}
|
||||||
|
{{ $.Scratch.Add "menuItems" $value.Section }}
|
||||||
|
{{ end }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ $menuItems := $.Scratch.Get "menuItems" }}
|
{{ $menuItems := $.Scratch.Get "menuItems" }}
|
||||||
{{ range $i, $key := $menuItems }}
|
{{ range $i, $key := $menuItems }}
|
||||||
{{ if ne $key "" }}
|
{{ if ne $key "" }}
|
||||||
|
|
||||||
{{ if not $.Site.Params.menu }}
|
{{ $value := (index $.Site.Sections $key) }}
|
||||||
{{ $.Scratch.Set "currentItem" (index $page.Site.Sections $i) }}
|
{{ $.Scratch.Set "_value" $value }}
|
||||||
{{ else }}
|
{{ with $index := $.Site.GetPage "section" $key }}
|
||||||
{{ $.Scratch.Set "currentItem" (index $page.Site.Sections $key) }}
|
{{ if .Content }}
|
||||||
|
{{ $.Scratch.Set "first" $index }}
|
||||||
|
{{ else if gt $value.Len 0}}
|
||||||
|
{{ $.Scratch.Set "first" (index $value 0).Page }}
|
||||||
|
{{ if gt $value.Len 1 }}
|
||||||
|
{{ $.Scratch.Set "_value" (after 1 $value) }}
|
||||||
|
{{ else }}
|
||||||
|
{{ $.Scratch.Set "_value" nil }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ $value := $.Scratch.Get "currentItem" }}
|
{{ $first := $.Scratch.Get "first" }}
|
||||||
{{ $first := (index $value 0).Page }}
|
{{ $value := $.Scratch.Get "_value" }}
|
||||||
|
|
||||||
<li class="dd-item {{ if eq $page.RelPermalink $first.RelPermalink }}active{{ end }} {{if in $page.RelPermalink $first.RelPermalink }}parent{{ end }}" data-nav-id="{{ $first.RelPermalink }}">
|
<li class="dd-item {{ if eq $.UniqueID $first.UniqueID }}active{{ end }} {{if eq $.Section $first.Section }}parent{{ end }}" data-nav-id="{{ $first.RelPermalink }}">
|
||||||
<a href="{{ $first.RelPermalink }}">
|
<a href="{{ $first.RelPermalink }}">
|
||||||
<span>
|
<span>
|
||||||
{{ if isset $first.Params "icon" }}
|
{{ if isset $first.Params "icon" }}
|
||||||
{{ printf $first.Params.icon | safeHTML }}
|
{{ printf $first.Params.icon | safeHTML }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ $first.Title }}
|
{{ $first.Title }}
|
||||||
{{ if $page.Site.Params.showVisitedLinks}}
|
{{ if $.Site.Params.showVisitedLinks}}
|
||||||
<i class="fa fa-check read-icon"></i>
|
<i class="fa fa-check read-icon"></i>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
{{ if gt $value.Len 1}}
|
{{ if gt $value.Len 0}}
|
||||||
<ul>
|
<ul>
|
||||||
{{ range $k, $p := $value }}
|
{{ range $k, $p := $value }}
|
||||||
{{ if gt $k 0 }}
|
<li class="dd-item {{ if eq $.UniqueID $p.Page.UniqueID }}active{{ end }}" data-nav-id="{{ $p.Page.RelPermalink }}">
|
||||||
<li class="dd-item {{ if eq $page.RelPermalink $p.Page.RelPermalink }}active{{ end }}" data-nav-id="{{ $p.Page.RelPermalink }}">
|
|
||||||
<a href="{{ $p.Page.RelPermalink }}">
|
<a href="{{ $p.Page.RelPermalink }}">
|
||||||
<span>{{ $p.Page.Title }} {{ if $page.Site.Params.showVisitedLinks}} <i class="fa fa-check read-icon"> {{ end }} </i></span>
|
<span>{{ $p.Page.Title }} {{ if $.Site.Params.showVisitedLinks}} <i class="fa fa-check read-icon"> {{ end }} </i></span>
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
{{ end }}
|
|
||||||
</ul>
|
</ul>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ description = "Documentation theme for Hugo, based on Grav Learn theme"
|
||||||
homepage = "https://matcornic.github.io/hugo-learn-doc/basics/what-is-this-hugo-theme/"
|
homepage = "https://matcornic.github.io/hugo-learn-doc/basics/what-is-this-hugo-theme/"
|
||||||
tags = ["documentation", "grav", "learn", "doc"]
|
tags = ["documentation", "grav", "learn", "doc"]
|
||||||
features = ["documentation"]
|
features = ["documentation"]
|
||||||
min_version = 0.17
|
min_version = 0.19
|
||||||
|
|
||||||
[author]
|
[author]
|
||||||
name = "Mathieu Cornic"
|
name = "Mathieu Cornic"
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue