feat: Update doks

assets/js/custom.js

@@ -0,0 +1 @@
+// Put your custom JS code here

assets/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "*": ["*", "..\\node_modules\\@hyas\\doks-core\\assets\\*"]
+    }
+  }
+}

assets/scss/common/_custom.scss

@@ -0,0 +1 @@
+// Put your custom SCSS code here

assets/scss/common/_variables-custom.scss

@@ -0,0 +1,7 @@
+// Put your custom SCSS variables here
+$green:    #43a047;
+$light-green: #8BC34A;
+
+$primary: $green;
+$primary-dark: $green;
+$primary-light: #8BC34A;

config/_default/config.toml → config/_default/hugo.toml

@@ -1,21 +1,29 @@
+title = "Planter Docs"
 baseurl = "https://info.planter.garden/"
 canonifyURLs = false
 disableAliases = true
 disableHugoGeneratorInject = true
 enableEmoji = true
 enableGitInfo = true
 enableRobotsTXT = true
-paginate = 7
+paginate = 10
 rssLimit = 10
+summarylength = 20 # 70 (default)
 
 # Multilingual
+languageCode = "en-US"
 defaultContentLanguage = "en"
 disableLanguages = ["de", "nl"]
-# defaultContentLanguageInSubdir = true
+defaultContentLanguageInSubdir = false
+
+copyRight = "Copyright (c) 2024 Planter LLC"
+
+[build.buildStats]
+enable = true
 
 # add redirects/headers
 [outputs]
-home = ["HTML", "RSS", "REDIRECTS", "HEADERS"]
+home = ["HTML", "RSS", "searchIndex", "REDIRECTS", "HEADERS"]
 section = ["HTML", "RSS", "SITEMAP"]
 
 # remove .{ext} from text/netlify
@@ -37,6 +45,12 @@ baseName = "_headers"
 isPlainText = true
 notAlternative = true
 
+[outputFormats.searchIndex]
+mediaType = "application/json"
+baseName = "search-index"
+isPlainText = true
+notAlternative = true
+
 # add output format for section sitemap.xml
 [outputFormats.SITEMAP]
 mediaType = "application/xml"
@@ -63,6 +77,7 @@ rel  = "sitemap"
 
 [permalinks]
   blog = "/blog/:title/"
+  docs = "/docs/:sections[1:]/:slug/"
 # docs = "/docs/1.0/:sections[1:]/:title/"
 
 [minify.tdewolff.html]
@@ -82,29 +97,9 @@ rel  = "sitemap"
     name = "date"
     weight = 10
 
-[module]
-  [module.hugoVersion]
-    extended = true
-    min = "0.80.0"
-    max = ""
-  [[module.mounts]]
-    source = "assets"
-    target = "assets"
-  [[module.mounts]]
-    source = "static"
-    target = "static"
-  [[module.mounts]]
-    source = "layouts"
-    target = "layouts"
-  [[module.mounts]]
-    source = "node_modules/flexsearch"
-    target = "assets/js/vendor/flexsearch"
-  [[module.mounts]]
-    source = "node_modules/katex"
-    target = "assets/js/vendor/katex"
-  [[module.mounts]]
-    source = "node_modules/mermaid"
-    target = "assets/js/vendor/mermaid"
-  [[module.mounts]]
-    source = "node_modules/@hyas/images/layouts"
-    target = "layouts"
+[imaging]
+  anchor = "Center"
+  bgColor = "#ffffff"
+  hint = "photo"
+  quality = 85
+  resampleFilter = "Lanczos"

config/_default/module.toml

@@ -0,0 +1,87 @@
+# mounts
+## archetypes
+[[mounts]]
+source = "node_modules/@hyas/doks-core/archetypes"
+target = "archetypes"
+
+[[mounts]]
+source = "archetypes"
+target = "archetypes"
+
+## assets
+[[mounts]]
+source = "node_modules/@hyas/core/assets"
+target = "assets"
+
+[[mounts]]
+source = "node_modules/@hyas/images/assets"
+target = "assets"
+
+[[mounts]]
+source = "node_modules/@hyas/doks-core/assets"
+target = "assets"
+
+[[mounts]]
+source = "node_modules/@tabler/icons/icons"
+target = "assets/svgs/tabler-icons"
+
+[[mounts]]
+source = "assets"
+target = "assets"
+
+## content
+[[mounts]]
+source = "content"
+target = "content"
+
+## data
+[[mounts]]
+source = "node_modules/@hyas/doks-core/data"
+target = "data"
+
+[[mounts]]
+source = "data"
+target = "data"
+
+## i18n
+[[mounts]]
+source = "node_modules/@hyas/doks-core/i18n"
+target = "i18n"
+
+[[mounts]]
+source = "i18n"
+target = "i18n"
+
+## layouts
+[[mounts]]
+source = "node_modules/@hyas/core/layouts"
+target = "layouts"
+
+[[mounts]]
+source = "node_modules/@hyas/seo/layouts"
+target = "layouts"
+
+[[mounts]]
+source = "node_modules/@hyas/images/layouts"
+target = "layouts"
+
+[[mounts]]
+source = "node_modules/@hyas/doks-core/layouts"
+target = "layouts"
+
+[[mounts]]
+source = "node_modules/@hyas/inline-svg/layouts"
+target = "layouts"
+
+[[mounts]]
+source = "layouts"
+target = "layouts"
+
+## static
+[[mounts]]
+source = "node_modules/@hyas/doks-core/static"
+target = "static"
+
+[[mounts]]
+source = "static"
+target = "static"

config/_default/params.toml

@@ -117,3 +117,131 @@ collapsibleSidebar = true
 [menu.section]
 auto = true
 collapsibleSidebar = true
+
+# 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.defaults]
+  decoding = "async" # sync, async, or auto (default)
+  fetchpriority = "auto" # high, low, or auto (default)
+  loading = "lazy" # eager or lazy (default)
+  widths = [480, 576, 768, 1025, 1200, 1440] # [640, 768, 1024, 1366, 1600, 1920] for example
+  sizes = "auto" # 100vw (default), 75vw, or auto for example
+  process = "" # "fill 1600x900" or "fill 2100x900" for example
+  lqip = "16x webp q20" # "16x webp q20" or "21x webp q20" for example
+
+# 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