站点配置
您可以将一些配置选项添加到hugo.toml文件中。 您还可以在此处看到yaml示例。
hugo.yaml
hugo.yaml
# 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
hugo.yaml
hugo.yaml
build:
buildStats:
disableIDs: true
enable: true
defaultContentLanguage: en
enableInlineShortcodes: true
enableGitInfo: true
enableRobotsTXT: true
hasCJKLanguage: true
languages:
en:
languageName: English
weight: 1
markup:
goldmark:
renderer:
unsafe: true
highlight:
noClasses: false
outputs:
home: [HTML]
page: [HTML]
section: [HTML, RSS]
params:
blog:
list:
displayTags: true
comments:
enable: false
giscus:
category: Discussions
categoryId: DIC_kwDOI0Z9Z84Cfhkt
emitMetadata: 0
inputPosition: bottom
lang: en
mapping: pathname
reactionsEnabled: 1
repo: axivo/website
repoId: R_kgDOI0Z9Zw
strict: 0
type: giscus
dateFormat: 'January 2, 2006'
displayUpdatedDate: true
footer:
displayCopyright: true
displayPoweredBy: false
enable: true
width: normal
navbar:
displayTitle: true
displayLogo: true
# logo:
# path: /logo.svg
# dark: /logo.svg
# link: /
# width: 20
# height: 10
# width: wide
page:
width: normal
theme:
default: system
displayToggle: true
hugo.yaml
hugo.yaml
# Configuration
baseURL: "https://docs.helixml.tech/"
timeout: "2m"
enableRobotsTXT: true
enableGitInfo: true
# enableEmoji: false
hasCJKLanguage: true
canonifyURLs: true
services:
googleAnalytics:
ID: G-85V4E1WPBP
outputs:
home: [HTML]
page: [HTML]
section: [HTML, RSS]
defaultContentLanguage: en
languages:
en:
languageName: English
weight: 1
title: Helix Docs
module:
hugoVersion:
extended: true
min: "0.124.0"
imports:
- path: github.com/imfing/hextra
mounts:
- source: "assets"
target: "assets"
- source: "fonts"
target: "static/fonts"
- source: "hugo_stats.json"
target: "assets/watching/hugo_stats.json"
build:
writeStats: true
cachebusters:
- source: "assets/watching/hugo_stats\\.json"
target: "styles\\.css"
- source: "(postcss|tailwind)\\.config\\.js"
target: "css"
- source: "assets/.*\\.(js|ts|jsx|tsx)"
target: "js"
- source: "assets/.*\\.(.*)$"
target: "$1"
markup:
goldmark:
renderer:
unsafe: true
highlight:
noClasses: false
enableInlineShortcodes: true
menu:
main:
- name: Home
url: https://tryhelix.ai/
weight: 1
- name: GitHub
weight: 97
url: "https://github.com/helixml/docs"
params:
icon: github
- name: Twitter
weight: 98
url: "https://twitter.com/helixml"
params:
icon: twitter
- name: Search
weight: 99
params:
type: search
params:
navbar:
displayTitle: true
displayLogo: true
logo:
path: /logo.svg
dark: /logo.svg
link: /
width: 20
height: 10
width: wide
page:
# full (100%), wide (90rem), normal (1280px)
width: normal
theme:
# light | dark | system
default: dark
displayToggle: false
footer:
enable: true
displayCopyright: true
displayPoweredBy: false
width: normal
displayUpdatedDate: true
dateFormat: "January 2, 2006"
# Search
# flexsearch is enabled by default
search:
enable: true
type: flexsearch
flexsearch:
# index page by: content | summary | heading | title
index: content
editURL:
enable: true
base: "https://github.com/helixml/docs/edit/main/content"
blog:
list:
displayTags: true
comments:
enable: false
type: giscus
# https://giscus.app/
giscus:
repo: imfing/hextra
repoId: R_kgDOJ9fJag
category: General
categoryId: DIC_kwDOJ9fJas4CY7gW
# mapping: pathname
# strict: 0
# reactionsEnabled: 1
# emitMetadata: 0
# inputPosition: top
# lang: en
searchbot:
urls:
websites: https://searchbot.tryhelix.ai/
bots: https://searchbot.tryhelix.ai/bots