feat: update for doks 1.0.0-beta.1

config/_default/hugo.toml

@@ -4,7 +4,7 @@ disableAliases = true
 disableHugoGeneratorInject = true
 # disableKinds = ["taxonomy", "term"]
 enableEmoji = true
-enableGitInfo = false
+enableGitInfo = true
 enableRobotsTXT = true
 languageCode = "en-US"
 paginate = 10
@@ -14,7 +14,7 @@ summarylength = 20 # 70 (default)
 # Multilingual
 defaultContentLanguage = "en"
 disableLanguages = ["de", "nl"]
-# defaultContentLanguageInSubdir = true
+defaultContentLanguageInSubdir = false
 
 [outputs]
   home = ["HTML", "RSS", "searchIndex"]

config/_default/hyas/doks.toml

@@ -1,11 +1,10 @@
 # Color mode
-colorMode = "auto" # auto (default), light or dark (the light and dark options are only relevant when forceColorMode = true)
-colorModeToggler = true # false (default) or true (this setting is only relevant when forceColorMode = false)
-forceColorMode = false # false (default) or true
+colorMode = "auto" # auto (default), light or dark
+colorModeToggler = true # true (default) or false (this setting is only relevant when colorMode = auto)
 
 # Navbar
-navbarSticky = true # false (default) or true
-containerBreakpoint = "xxl" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
+navbarSticky = true # true (default) or false
+containerBreakpoint = "lg" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid"
 
 ## Button
 navBarButton = false # false (default) or true
@@ -35,24 +34,44 @@ sectionNav = ["docs"] # ["docs"] (default) or list of sections (e.g. ["docs", "g
 toTopButton = false # false (default) or true
 breadcrumbTrail = false # false (default) or true
 headlineHash = true # true (default) or false
-scrollSpy = true # false (default) or true
+scrollSpy = true # true (default) or false
 
 # Multilingual
 multilingualMode = false # false (default) or true
 
 # Versioning
 docsVersioning = false # false (default) or true
+docsVersion = "1.0"
 
 # UX
 headerBar = true # true (default)  or false
 backgroundDots = true # true (default)  or false
 
 # Homepage
-sectionFooter = false # true (default)  or false
+sectionFooter = false # false (default) or true
 
 # Blog
 relatedPosts = false # false (default) or true
 
+# 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
+repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer
+docsRepo = "https://github.com/h-enk/doks"
+docsRepoBranch = "main"
+docsRepoSubPath = ""
+editPage = false # false (default) or true
+lastMod = false # false (default) or true
+
+[menu]
+  [menu.section]
+    auto = true
+    collapsibleSidebar = true
+
 # SCSS
 # backGround = "yellowgreen"
 
@@ -65,4 +84,3 @@ relatedPosts = false # false (default) or true
 ## Light theme
 # textLight =  "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color
 # accentLight =  "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color
- 

config/_default/hyas/images.toml

@@ -0,0 +1 @@
+# See .config/_default/params.toml

config/_default/hyas/seo.toml

@@ -0,0 +1 @@
+# See .config/_default/params.toml

config/_default/params.toml

@@ -1,23 +1,27 @@
-# Meta Data for SEO
+# Hyas (gethyas)
+
+## Feed
+copyRight = "Copyright (c) 2020-2021 Henk Verlinde"
+
+# SEO (@hyas/seo)
 
 ## Homepage
 title = "Doks"
-titleSeparator = "-"
+titleSeparator = "-" # - (default)
 titleAddition = "Modern Documentation Theme"
-description = "Hyas is a Hugo starter helping you build modern websites that are secure, fast, and SEO-ready — by default."
+description = "Doks is a Hyas theme for building custom, production-ready documentation websites." # Default description
 
 ## Open Graph
 images = ["hyas.png"]
 ogLocale = "en_US"
-titleHome = "Hyas Hugo Starter"
+titleHome = "Modern Documentation Theme"
 
 ## Twitter Cards
 twitterSite = "@gethyas"
 twitterCreator = "@henkverlinde"
 
 ## JSON-LD
-# schemaType = "Person"
-schemaType = "Organization"
+schemaType = "Organization" # Organization (default) or Person
 schemaName = "Hyas"
 schemaAuthor = "Henk Verlinde"
 schemaAuthorTwitter = "https://twitter.com/henkverlinde"
@@ -34,80 +38,21 @@ schemaTwitter = "https://twitter.com/gethyas"
 schemaLinkedIn = ""
 schemaGitHub = "https://github.com/h-enk/hyas"
 
-# Feed
-copyRight = "Copyright (c) 2020-2021 Henk Verlinde"
+# Images (@hyas/images)
 
-# 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>"
-
-## Documentation
-# docsVersion = "1.0"
-
-# Edit Page
-# repoHost [Github | Gitea | GitLab | Bitbucket | BitbucketServer ] is used for building the edit link based on git hoster
-repoHost = "GitHub"
-#repoHost = "Gitea"
-docsRepo = "https://github.com/h-enk/doks"
-docsRepoBranch = "master"
-docsRepoSubPath = ""
-editPage = true
-lastMod = false
-
-# Images
-
-## defaultImage
-defaultImage = "default-image.jpg" # put in `./assets/images/`
-
-## imaging
-[imaging]
-  anchor = 'Smart'
-  bgColor = '#fff'
-  hint = 'photo'
-  quality = 95
-  resampleFilter = 'Lanczos'
-
-## lazyimg
 [lazyimg]
   resizer = "auto"
-  renderer = "lqip-webp"
+  renderer = "lqip-webp" # "lqip (default)"
 
   # Resizer options:
   lqipSize = "120x Gaussian"
-  # maxSize = "1920x"
-  maxSize = "1366x"
+  maxSize = "1024x" # "1920x" (default)
   responsiveSizes = [ "320x", "640x", "768x", "1024x", "1366x", "1600x", "1920x" ]
   resizeOptions = "Lanczos q95"
 
   # Renderer options:
   class = "img-fluid"
-  # alt = ""
+  # alt = "" # Default alt tag
   noscript = true
 
-  errorHandler = "warning"
-
-[sections]
-  sectionNav = ["docs", "guides", "books"]
-
-[options]
-  lazySizes = true # no longer an option (included by default)
-  clipBoard = true # no longer an option (included by default)
-  instantPage = false # no longer an option (replaced with quicklink, included by default)
-  flexSearch = true # new setup
-  searchSectionsShow = [] # new setup
-  searchSectionsIndex = [] # new setup
-  darkMode = true # new setup
-  bootStrapJs = true # new setup
-  breadCrumb = false # new setup
-  highLight = false # no longer an option (dropped, use Hugo's Chroma syntax highlighting)
-  kaTex = false
-  multilingualMode = false
-  docsVersioning = false
-  fullWidth = false # new setup
-  navbarSticky = true # same option
-  toTopButton = false # new setup (included by default)
-  scrollSpy = false # experimental; needs Bootstrap >= 5.2.0-beta1
-
-[menu]
-  [menu.section]
-    auto = true
-    collapsibleSidebar = true
+  errorHandler = "warning" # "warning-remote" (default)