summaryrefslogtreecommitdiff
path: root/themes/hugo-book/exampleSite/hugo.toml
diff options
context:
space:
mode:
authoraethrvmn <me@aethrvmn.gr>2025-09-20 22:27:35 +0000
committeraethrvmn <me@aethrvmn.gr>2025-09-20 22:27:35 +0000
commit9b5f3fad7068298265dbbc8a65077f7917a090a5 (patch)
tree0905b29eb7c03d6bc6e16dd1ebcd1ec9b6b83320 /themes/hugo-book/exampleSite/hugo.toml
parentsuper simple setup guide (diff)
updated hugo-book theme
Diffstat (limited to 'themes/hugo-book/exampleSite/hugo.toml')
-rw-r--r--themes/hugo-book/exampleSite/hugo.toml65
1 files changed, 45 insertions, 20 deletions
diff --git a/themes/hugo-book/exampleSite/hugo.toml b/themes/hugo-book/exampleSite/hugo.toml
index 34af293..a5aa8cb 100644
--- a/themes/hugo-book/exampleSite/hugo.toml
+++ b/themes/hugo-book/exampleSite/hugo.toml
@@ -1,6 +1,6 @@
-# hugo server --minify --themesDir ../.. --baseURL=http://0.0.0.0:1313/theme/hugo-book/
+# hugo server --minify --themesDir ../..
-baseURL = 'https://example.com/'
+baseURL = 'http://0.0.0.0:1313/hugo-book/'
title = 'Hugo Book'
theme = 'hugo-book'
@@ -38,10 +38,37 @@ enableGitInfo = true
weight = 3
[menu]
+[[menu.home]]
+ name = "Documentation"
+ url = "/docs/example/"
+ weight = 1
+
+[[menu.home]]
+ name = "Introduction"
+ url = "/docs/example/"
+ weight = 10
+ parent = "Documentation"
+
+[[menu.home]]
+ name = "Shortcodes"
+ url = "/docs/shortcodes/badges/"
+ weight = 20
+ parent = "Documentation"
+
+[[menu.home]]
+ name = "Showcases"
+ url = "/showcases/"
+ weight = 2
+
+[[menu.home]]
+ name = "Github"
+ url = "https://github.com/alex-shpak/hugo-book/"
+ weight = 3
+
# [[menu.before]]
[[menu.after]]
name = "Github"
- url = "https://github.com/alex-shpak/hugo-book"
+ url = "https://github.com/alex-shpak/hugo-book/"
weight = 10
[[menu.after]]
@@ -54,10 +81,10 @@ enableGitInfo = true
# Theme 'auto' switches between dark and light modes based on browser/os preferences
BookTheme = 'light'
- # (Optional, default true) Controls table of contents visibility on right side of pages.
+ # (Optional, default none) Controls table of contents visibility on right side of pages.
# Start and end levels can be controlled with markup.tableOfContents setting.
# You can also specify this parameter per page in front matter.
- BookToC = true
+ # BookToC = true
# (Optional, default favicon.png) Set the path to a favicon file.
# If the favicon is /static/favicon.png then the path would be favicon.png
@@ -72,28 +99,26 @@ enableGitInfo = true
# For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
BookSection = 'docs'
- # Set source repository location.
- # Used for 'Last Modified' and 'Edit this page' links.
- BookRepo = 'https://github.com/alex-shpak/hugo-book'
+ # Here for backwar compatibility, not required.
+ BookRepo = 'https://github.com/alex-shpak/hugo-book/'
- # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
- # commit hash for 'doc' page type.
- # Requires 'BookRepo' param.
- # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
- # Github uses 'commit', Bitbucket uses 'commits'
- # BookCommitPath = 'commit'
+ # (Optional, default none) Set template for commit link for the page. Requires enableGitInfo.
+ # When set enabled 'Last Modified' and a link to the commit in the footer of the page.
+ # Param is executed as template using .Site, .Page and .GitInfo as context.
+ BookLastChangeLink = '{{ .Site.Params.BookRepo }}/commit/{{ .GitInfo.Hash }}'
- # Enable "Edit this page" links for 'doc' page type.
- # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
- # Edit path must point to root directory of repo.
- BookEditPath = 'edit/main/exampleSite'
+ # (Optional, default none) Set template for edit page link.
+ # When set enabled 'Edit this page' link in the footer of the page.
+ # Param is executed as template using .Site, .Page and .Path as context.
+ BookEditLink = '{{ .Site.Params.BookRepo }}/edit/main/exampleSite/{{ .Path }}'
- # Configure the date format used on the pages
+ # (Optional, default 'January 2, 2006') Configure the date format used on the pages
# - In git information
# - In blog posts
+ # https://gohugo.io/functions/time/format/
BookDateFormat = 'January 2, 2006'
- # (Optional, default true) Enables search function with flexsearch,
+ # (Optional, default true) Enables search function with fuse.js.,
# Index is built on fly, therefore it might slowdown your website.
# Configuration for indexing can be adjusted in i18n folder per language.
BookSearch = true
Directive (EU) 2019/790, Article 4(3); all rights regarding Text and Data Mining (TDM) are reserved.