1  # hugo server --minify --themesDir ../.. --baseURL=http://0.0.0.0:1313/theme/hugo-book/
  2  
  3  baseURL: https://example.com/
  4  title: Hugo Book
  5  theme: hugo-book
  6  
  7  # Book configuration
  8  disablePathToLower: true
  9  enableGitInfo: true
 10  
 11  # Needed for mermaid/katex shortcodes
 12  markup:
 13    goldmark:
 14      renderer:
 15        unsafe: true
 16    tableOfContents:
 17      startLevel: 1
 18  
 19  # Multi-lingual mode config
 20  # There are different options to translate files
 21  # See https://gohugo.io/content-management/multilingual/#translation-by-filename
 22  # And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
 23  languages:
 24    en:
 25      languageName: English
 26      contentDir: content.en
 27      weight: 1
 28    zh:
 29      languageName: Chinese
 30      contentDir: content.zh
 31      weight: 2
 32    he:
 33      languageName: Hebrew
 34      contentDir: content.he
 35      languageDirection: rtl
 36      weight: 3
 37  
 38  menu:
 39    # before: []
 40    after:
 41      - name: "Github"
 42        url: "https://github.com/alex-shpak/hugo-book"
 43        weight: 10
 44      - name: "Hugo Themes"
 45        url: "https://themes.gohugo.io/themes/hugo-book/"
 46        weight: 20
 47  
 48  params:
 49    # (Optional, default light) Sets color theme: light, dark or auto.
 50    # Theme 'auto' switches between dark and light modes based on browser/os preferences
 51    BookTheme: "light"
 52  
 53    # (Optional, default true) Controls table of contents visibility on right side of pages.
 54    # Start and end levels can be controlled with markup.tableOfContents setting.
 55    # You can also specify this parameter per page in front matter.
 56    BookToC: true
 57  
 58    # (Optional, default favicon.png) Set the path to a favicon file.
 59    # If the favicon is /static/favicon.png then the path would be favicon.png
 60    # BookFavicon: "favicon.png"
 61  
 62    # (Optional, default none) Set the path to a logo for the book.
 63    # If the logo is /static/logo.png then the path would be logo.png
 64    # BookLogo: /logo.png
 65  
 66    # (Optional, default docs) Specify root page to render child pages as menu.
 67    # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
 68    # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
 69    BookSection: docs
 70  
 71    # Set source repository location.
 72    # Used for 'Last Modified' and 'Edit this page' links.
 73    BookRepo: https://github.com/alex-shpak/hugo-book
 74  
 75    # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
 76    # commit hash for 'doc' page type.
 77    # Requires 'BookRepo' param.
 78    # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
 79    # Github uses 'commit', Bitbucket uses 'commits'
 80    # BookCommitPath: commit
 81  
 82    # Enable "Edit this page" links for 'doc' page type.
 83    # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
 84    # Edit path must point to root directory of repo.
 85    BookEditPath: edit/main/exampleSite
 86  
 87    # Configure the date format used on the pages
 88    # - In git information
 89    # - In blog posts
 90    BookDateFormat: "January 2, 2006"
 91  
 92    # (Optional, default true) Enables search function with flexsearch,
 93    # Index is built on fly, therefore it might slowdown your website.
 94    # Configuration for indexing can be adjusted in i18n folder per language.
 95    BookSearch: true
 96  
 97    # (Optional, default true) Enables comments template on pages
 98    # By default partals/docs/comments.html includes Disqus template
 99    # See https://gohugo.io/content-management/comments/#configure-disqus
100    # Can be overwritten by same param in page frontmatter
101    BookComments: true
102  
103    # /!\ This is an experimental feature, might be removed or changed at any time
104    # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
105    # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
106    # Theme will print warning if page referenced in markdown does not exists.
107    BookPortableLinks: true
108  
109    # /!\ This is an experimental feature, might be removed or changed at any time
110    # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
111    BookServiceWorker: true
112  
113    # /!\ This is an experimental feature, might be removed or changed at any time
114    # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
115    BookTranslatedOnly: false