139 lines
4.9 KiB
TOML
139 lines
4.9 KiB
TOML
# Hugo
|
|
title = "My Docs"
|
|
description = "Congrats on setting up a new Doks project!"
|
|
images = ["cover.png"]
|
|
|
|
# mainSections
|
|
mainSections = ["docs"]
|
|
|
|
[social]
|
|
twitter = "getdoks"
|
|
|
|
# Doks (@hyas/doks-core)
|
|
[doks]
|
|
# Color mode
|
|
colorMode = "auto" # auto (default), light or dark
|
|
colorModeToggler = true # true (default) or false (this setting is only relevant when colorMode = auto)
|
|
|
|
# Navbar
|
|
navbarSticky = true # true (default) or false
|
|
containerBreakpoint = "lg" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
|
|
|
|
## Button
|
|
navBarButton = false # false (default) or true
|
|
navBarButtonUrl = "/docs/prologue/introduction/"
|
|
navBarButtonText = "Get started"
|
|
|
|
# FlexSearch
|
|
flexSearch = true # true (default) or false
|
|
searchExclKinds = [] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] )
|
|
searchExclTypes = [] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"])
|
|
showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])
|
|
indexSummary = false # true or false (default); whether to index only the `.Summary` instead of the full `.Content`; limits the respective JSON field size and thus increases loading time
|
|
|
|
## Search results
|
|
showDate = false # false (default) or true
|
|
showSummary = true # true (default) or false
|
|
searchLimit = 99 # 0 (no limit, default) or natural number
|
|
|
|
# Global alert
|
|
alert = false # false (default) or true
|
|
alertDismissable = true # true (default) or false
|
|
|
|
# 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
|
|
scrollSpy = true # true (default) or false
|
|
|
|
# Multilingual
|
|
multilingualMode = false # false (default) or true
|
|
showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false
|
|
|
|
# Versioning
|
|
docsVersioning = false # false (default) or true
|
|
docsVersion = "1.0"
|
|
|
|
# UX
|
|
headerBar = false # true (default) or false
|
|
backgroundDots = true # true (default) or false
|
|
|
|
# Homepage
|
|
sectionFooter = false # false (default) or true
|
|
|
|
# Blog
|
|
relatedPosts = false # false (default) or true
|
|
imageList = true # true (default) or false
|
|
imageSingle = true # true (default) or false
|
|
|
|
# Repository
|
|
editPage = false # false (default) or true
|
|
lastMod = false # false (default) or true
|
|
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>
|
|
|
|
# SCSS colors
|
|
# backGround = "yellowgreen"
|
|
## 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
|
|
|
|
[doks.menu]
|
|
[doks.menu.section]
|
|
auto = true # true (default) or false
|
|
collapsibleSidebar = true # true (default) or false
|
|
|
|
# Debug
|
|
[render_hooks.image]
|
|
errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
|
|
|
|
[render_hooks.link]
|
|
errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
|
|
highlightBroken = false # true or false (default)
|
|
|
|
# Images (@hyas/images)
|
|
[hyas_images]
|
|
[hyas_images.landscape]
|
|
normalize = "1360x765" # "1600x900" (default)
|
|
lqip = "16x9" # "16x9" (default)
|
|
widths = [480, 640, 800, 1024]
|
|
[hyas_images.portrait]
|
|
normalize = "765x1360" # "900x1600" (default)
|
|
lqip = "9x16" # "9x16" (default)
|
|
widths = [480, 640, 800, 1024]
|
|
|
|
# Inline SVG (@hyas/inline-svg)
|
|
[inline_svg]
|
|
iconSetDir = "tabler-icons" # "tabler-icons" (default)
|
|
|
|
# SEO (@hyas/seo)
|
|
[seo]
|
|
[seo.title]
|
|
separator = " | "
|
|
suffix = ""
|
|
[seo.favicons]
|
|
sizes = []
|
|
icon = "favicon.png" # favicon.png (default)
|
|
svgIcon = "favicon.svg" # favicon.svg (default)
|
|
maskIcon = "mask-icon.svg" # mask-icon.svg (default)
|
|
maskIconColor = "white" # white (default)
|
|
[seo.schemas]
|
|
type = "Organization" # Organization (default) or Person
|
|
logo = "favicon-512x512.png" # Logo of Organization — favicon-512x512.png (default)
|
|
name = "Hyas" # Name of Organization or Person
|
|
sameAs = [] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"]
|
|
images = ["cover.png"] # ["cover.png"] (default)
|
|
article = [] # Article sections
|
|
newsArticle = [] # NewsArticle sections
|
|
blogPosting = ["blog"] # BlogPosting sections
|
|
product = [] # Product sections
|