forked from vieter-v/vieter
116 lines
4.3 KiB
TOML
116 lines
4.3 KiB
TOML
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
|
|
|
baseURL = 'https://rustybever.be/docs/vieter/'
|
|
title = 'The Rusty Bever - Docs'
|
|
theme = 'hugo-book'
|
|
|
|
# Book configuration
|
|
disablePathToLower = true
|
|
# Doesn't work with docs as subdir
|
|
enableGitInfo = true
|
|
|
|
# Needed for mermaid/katex shortcodes
|
|
[markup]
|
|
[markup.goldmark.renderer]
|
|
unsafe = true
|
|
|
|
[markup.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]
|
|
[languages.en]
|
|
languageName = 'English'
|
|
contentDir = 'content'
|
|
weight = 1
|
|
|
|
[menu]
|
|
[[menu.after]]
|
|
name = "HTTP API Docs"
|
|
url = "https://rustybever.be/docs/vieter/api/"
|
|
weight = 10
|
|
[[menu.after]]
|
|
name = "Man Pages"
|
|
url = "https://rustybever.be/man/vieter/vieter.1.html"
|
|
weight = 20
|
|
[[menu.after]]
|
|
name = "Git"
|
|
url = "https://git.rustybever.be/vieter/vieter"
|
|
weight = 30
|
|
[[menu.after]]
|
|
name = "Hugo Theme"
|
|
url = "https://github.com/alex-shpak/hugo-book"
|
|
weight = 40
|
|
|
|
[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 = 'auto'
|
|
|
|
# (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 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 none) Set leaf bundle to render as side menu
|
|
# When not specified file structure and weights will be used
|
|
# BookMenuBundle = '/menu'
|
|
|
|
# (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 = '/'
|
|
|
|
# Set source repository location.
|
|
# Used for 'Last Modified' and 'Edit this page' links.
|
|
BookRepo = 'https://git.rustybever.be/vieter/vieter'
|
|
|
|
# (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 = 'src/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 = false
|
|
|
|
# /!\ 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
|