portails/config/_default/hyas/doks.toml

87 lines
2.9 KiB
TOML
Raw Normal View History

2023-04-18 15:10:33 +02:00
# Color mode
2023-05-26 17:44:05 +02:00
colorMode = "auto" # auto (default), light or dark
colorModeToggler = true # true (default) or false (this setting is only relevant when colorMode = auto)
2023-04-18 15:10:33 +02:00
# Navbar
2023-05-26 17:44:05 +02:00
navbarSticky = true # true (default) or false
containerBreakpoint = "lg" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
2023-04-18 15:10:33 +02:00
## Button
navBarButton = false # false (default) or true
navBarButtonUrl = "/docs/prologue/introduction/"
navBarButtonText = "Get started"
# FlexSearch
flexSearch = true # true (default) or false
indexPages = [] # [] (all regular pages, default) or list of sections (e.g. ["blog", "guides"])
showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])
## Search results
showDate = false # false (default) or true
showSummary = true # true (default) or false
searchLimit = 5 # 0 (no limit, default) or natural number
# Global alert
alert = false # false (default) or true
alertDismissable = true # true (default) or false
2023-05-23 14:55:30 +02:00
alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/doks-1/">Doks version 1.0 just shipped!</a>'
2023-04-18 15:10:33 +02:00
# Bootstrap
bootstrapJavascript = false # false (default) or true
# Nav
sectionNav = ["docs"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
toTopButton = false # false (default) or true
breadcrumbTrail = false # false (default) or true
headlineHash = true # true (default) or false
2023-05-26 17:44:05 +02:00
scrollSpy = true # true (default) or false
2023-04-18 15:10:33 +02:00
# Multilingual
multilingualMode = false # false (default) or true
# Versioning
docsVersioning = false # false (default) or true
2023-05-26 17:44:05 +02:00
docsVersion = "1.0"
2023-04-18 15:10:33 +02:00
# UX
headerBar = true # true (default) or false
backgroundDots = true # true (default) or false
# Homepage
2023-05-26 17:44:05 +02:00
sectionFooter = false # false (default) or true
2023-04-18 15:10:33 +02:00
# Blog
relatedPosts = false # false (default) or true
2023-05-26 17:44:05 +02:00
# Footer
footer = "Powered by <a class=\"text-muted\" href=\"https://www.netlify.com/\">Netlify</a>, <a class=\"text-muted\" href=\"https://gohugo.io/\">Hugo</a>, and <a class=\"text-muted\" href=\"https://getdoks.org/\">Doks</a>"
# kaTex
kaTex = false
# Repository
editPage = false # false (default) or true
lastMod = false # false (default) or true
2023-06-17 15:53:53 +02:00
repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer
docsRepo = "https://github.com/h-enk/doks"
docsRepoBranch = "main" # main (default), master, or <branch name>
docsRepoSubPath = "" # "" (none, default) or <sub path>
2023-05-26 17:44:05 +02:00
[menu]
[menu.section]
2023-06-17 15:53:53 +02:00
auto = true # true (default) or false
collapsibleSidebar = true # true (default) or false
2023-05-26 17:44:05 +02:00
2023-04-18 15:10:33 +02:00
# SCSS
# backGround = "yellowgreen"
# Colors
## Dark theme
# textDark = "#dee2e6" # "#dee2e6" (default), "#dee2e6" (orignal), or custom color
# accentDark = "#5d2f86" # "#5d2f86" (default), "#5d2f86" (original), or custom color
## Light theme
# textLight = "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color
# accentLight = "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color