summaryrefslogtreecommitdiff
path: root/themes/hugo-book/exampleSite/hugo.yaml
diff options
context:
space:
mode:
authoraethrvmn <me@aethrvmn.gr>2025-08-30 13:17:32 +0000
committeraethrvmn <me@aethrvmn.gr>2025-08-30 13:17:32 +0000
commit1147a663e70aadb2578cbe601bc723d7cd939c5a (patch)
treeb5100d2031328be3cfd3e9ae62730436bd573e0f /themes/hugo-book/exampleSite/hugo.yaml
parentadded .gitignore (diff)
added non-content
Diffstat (limited to 'themes/hugo-book/exampleSite/hugo.yaml')
-rw-r--r--themes/hugo-book/exampleSite/hugo.yaml115
1 files changed, 115 insertions, 0 deletions
diff --git a/themes/hugo-book/exampleSite/hugo.yaml b/themes/hugo-book/exampleSite/hugo.yaml
new file mode 100644
index 0000000..3fd0c40
--- /dev/null
+++ b/themes/hugo-book/exampleSite/hugo.yaml
@@ -0,0 +1,115 @@
+# hugo server --minify --themesDir ../.. --baseURL=http://0.0.0.0:1313/theme/hugo-book/
+
+baseURL: https://example.com/
+title: Hugo Book
+theme: hugo-book
+
+# Book configuration
+disablePathToLower: true
+enableGitInfo: true
+
+# Needed for mermaid/katex shortcodes
+markup:
+ goldmark:
+ renderer:
+ unsafe: true
+ tableOfContents:
+ startLevel: 1
+
+# Multi-lingual mode config
+# There are different options to translate files
+# See https://gohugo.io/content-management/multilingual/#translation-by-filename
+# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
+languages:
+ en:
+ languageName: English
+ contentDir: content.en
+ weight: 1
+ zh:
+ languageName: Chinese
+ contentDir: content.zh
+ weight: 2
+ he:
+ languageName: Hebrew
+ contentDir: content.he
+ languageDirection: rtl
+ weight: 3
+
+menu:
+ # before: []
+ after:
+ - name: "Github"
+ url: "https://github.com/alex-shpak/hugo-book"
+ weight: 10
+ - name: "Hugo Themes"
+ url: "https://themes.gohugo.io/themes/hugo-book/"
+ weight: 20
+
+params:
+ # (Optional, default light) Sets color theme: light, dark or auto.
+ # 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.
+ # Start and end levels can be controlled with markup.tableOfContents setting.
+ # You can also specify this parameter per page in front matter.
+ 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
+ # BookFavicon: "favicon.png"
+
+ # (Optional, default none) Set the path to a logo for the book.
+ # If the logo is /static/logo.png then the path would be logo.png
+ # BookLogo: /logo.png
+
+ # (Optional, default docs) Specify root page to render child pages as menu.
+ # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
+ # 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
+
+ # 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
+
+ # Configure the date format used on the pages
+ # - In git information
+ # - In blog posts
+ BookDateFormat: "January 2, 2006"
+
+ # (Optional, default true) Enables search function with flexsearch,
+ # Index is built on fly, therefore it might slowdown your website.
+ # Configuration for indexing can be adjusted in i18n folder per language.
+ BookSearch: true
+
+ # (Optional, default true) Enables comments template on pages
+ # By default partals/docs/comments.html includes Disqus template
+ # See https://gohugo.io/content-management/comments/#configure-disqus
+ # Can be overwritten by same param in page frontmatter
+ BookComments: true
+
+ # /!\ This is an experimental feature, might be removed or changed at any time
+ # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
+ # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
+ # Theme will print warning if page referenced in markdown does not exists.
+ BookPortableLinks: true
+
+ # /!\ This is an experimental feature, might be removed or changed at any time
+ # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
+ BookServiceWorker: true
+
+ # /!\ This is an experimental feature, might be removed or changed at any time
+ # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
+ BookTranslatedOnly: false
Directive (EU) 2019/790, Article 4(3); all rights regarding Text and Data Mining (TDM) are reserved.