summaryrefslogtreecommitdiff
path: root/themes/hugo-book/exampleSite/hugo.yaml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--themes/hugo-book/exampleSite/hugo.yaml52
1 files changed, 33 insertions, 19 deletions
diff --git a/themes/hugo-book/exampleSite/hugo.yaml b/themes/hugo-book/exampleSite/hugo.yaml
index 3fd0c40..d404579 100644
--- a/themes/hugo-book/exampleSite/hugo.yaml
+++ b/themes/hugo-book/exampleSite/hugo.yaml
@@ -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
@@ -36,6 +36,25 @@ languages:
weight: 3
menu:
+ home:
+ - name: "Documentation"
+ url: "/docs/example/"
+ weight: 1
+ - name: "Introduction"
+ url: "/docs/example/"
+ weight: 10
+ parent: "Documentation"
+ - name: "Shortcodes"
+ url: "/docs/shortcodes/badges/"
+ weight: 20
+ parent: "Documentation"
+ - name: "Showcases"
+ url: "/showcases/"
+ weight: 2
+ - name: "Github"
+ url: "https://github.com/alex-shpak/hugo-book/"
+ weight: 3
+
# before: []
after:
- name: "Github"
@@ -50,10 +69,10 @@ params:
# 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
@@ -68,25 +87,20 @@ params:
# 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
-
- # (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: 'https://github.com/alex-shpak/hugo-book/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: 'https://github.com/alex-shpak/hugo-book/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,
Directive (EU) 2019/790, Article 4(3); all rights regarding Text and Data Mining (TDM) are reserved.