feat: add show_related option to control related content

The following option has been added to `params.toml` to control related content on pages:

`show_related = {docs = true, page = false, post = true, project = true, publication = true, talk = true}`
This commit is contained in:
George Cushen committed 2020-05-27 01:23:10 +01:00
1 parent 67028328d0
commit 9e562fc076
5 files changed
+54 -16

No files matched your search

+30 -2
View File
@@ -1,5 +1,6 @@
# Configuration of Academic
# Documentation: https://sourcethemes.com/academic/
# Configuration of Hugo
# Guide: https://sourcethemes.com/academic/docs/get-started/
# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings
#
# This file is formatted using TOML syntax - learn more at https://learnxinyminutes.com/docs/toml/
# Each configuration section is defined by a name in square brackets (e.g. `[outputs]`).
@@ -55,6 +56,7 @@ ignoreFiles = ["\\.ipynb$", ".ipynb_checkpoints$", "\\.Rmd$", "\\.Rmarkdown$", "
mediaType = "application/manifest+json"
rel = "manifest"
# Configure the Markdown renderer.
[markup]
defaultMarkdownHandler = "goldmark"
[markup.goldmark]
@@ -77,3 +79,29 @@ ignoreFiles = ["\\.ipynb$", ".ipynb_checkpoints$", "\\.Rmd$", "\\.Rmarkdown$", "
category = "categories"
publication_type = "publication_types"
author = "authors"
# Related content.
[related]
threshold = 80.0
includeNewer = true
toLower = true
[[related.indices]]
name = "title"
weight = 60.0
[[related.indices]]
name = "summary"
weight = 50.0
[[related.indices]]
name = "tags"
weight = 80.0
[[related.indices]]
name = "categories"
weight = 70.0
[[related.indices]]
name = "authors"
weight = 20.0
+8 -1
View File
@@ -1,5 +1,9 @@
# SITE SETUP
# Documentation: https://sourcethemes.com/academic/
# Guide: https://sourcethemes.com/academic/docs/get-started/
# Documentation: https://sourcethemes.com/academic/docs/
#
# This file is formatted using TOML syntax - learn more at https://learnxinyminutes.com/docs/toml/
# Each configuration section is defined by a name in square brackets (e.g. `[search]`).
############################
## Theme
@@ -73,6 +77,9 @@ privacy_pack = false
# `repo` defines the repository URL. `editable` defines which page types can be edited.
edit_page = {repo_url = "https://github.com/gcushen/hugo-academic", content_dir = "", repo_branch = "master", editable = {docs = true, page = false, post = false}}
# Show related content at the bottom of pages?
show_related = {docs = true, page = false, post = true, project = true, publication = true, talk = true}
############################
## Contact details
##
+2
View File
@@ -44,6 +44,8 @@
{{ partial "page_edit" . }}
{{ partial "comments" . }}
{{ partial "page_related" . }}
</div>
</article>
+1 -13
View File
@@ -10,16 +10,4 @@
</div>
{{ end }}
{{ if ne .Type "page" }}
{{ $related := site.RegularPages.Related . | first 5 }}
{{ with $related }}
<div class="article-widget content-widget-hr">
<h3>{{ i18n "related" }}</h3>
<ul>
{{ range . }}
<li><a href="{{ .RelPermalink }}">{{ .Title }}</a></li>
{{ end }}
</ul>
</div>
{{ end }}
{{ end }}
{{ partial "page_related" . }}
+13
View File
@@ -0,0 +1,13 @@
{{ if (index site.Params.show_related .Type) | and (ne .Params.show_related false) | or .Params.show_related }}
{{ $related := site.RegularPages.Related . | first 5 }}
{{ with $related }}
<div class="article-widget content-widget-hr">
<h3>{{ i18n "related" }}</h3>
<ul>
{{ range . }}
<li><a href="{{ .RelPermalink }}">{{ .Title }}</a></li>
{{ end }}
</ul>
</div>
{{ end }}
{{ end }}