deps: bumps @hyas/doks-core from 1.0.3 to 1.1.0

README.md

@@ -6,8 +6,6 @@ Doks is a documentation theme for [Hyas](https://gethyas.com/).
 
 - [doks.netlify.app](https://doks.netlify.app/)
 
-
-
 ## Install
 
 The recommended way to install the latest version of Doks is by running the command below:

assets/scss/common/_variables-custom.scss

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

config/_default/hugo.toml

@@ -19,6 +19,9 @@ defaultContentLanguageInSubdir = false
 
 copyRight = "Copyright (c) 2020-2023 Henk Verlinde"
 
+[build.buildStats]
+  enable = true
+
 [social]
   twitter = "getdoks"
 

config/_default/hyas/doks.toml

@@ -1,88 +0,0 @@
-# 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"])
-
-## 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
-alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
-
-# 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 # false (default) or true
-backgroundDots = true # true (default)  or false
-
-# Homepage
-sectionFooter = false # false (default) or true
-
-# Blog
-relatedPosts = false # false (default) or true
-
-# Footer
-footer = "Brought to you by <a class=\"text-muted\" href=\"https://gethyas.com/\">Hyas</a>"
-
-# KaTex
-katex = 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>
-
-[menu]
-  [menu.section]
-    auto = true # true (default) or false
-    collapsibleSidebar = true # true (default) or false
-
-# 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

config/_default/hyas/images.toml

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

config/_default/hyas/inline-svg.toml

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

config/_default/hyas/seo.toml

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

config/_default/languages.toml

@@ -5,6 +5,8 @@
   [en.params]
     languageISO = "EN"
     languageTag = "en-US"
+    footer = 'Brought to you by <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
+    alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
 
 [de]
   languageName = "German"
@@ -13,6 +15,8 @@
   [de.params]
     languageISO = "DE"
     languageTag = "de-DE"
+    footer = 'Gebaut mit <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
+    alertText = 'Neue Version ist da! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.5/">Doks v0.5</a>'
 
 [nl]
   languageName = "Nederlands"
@@ -24,5 +28,5 @@
     titleAddition = "Modern documentatie-thema"
     description = "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
     titleHome = "Doks thema"
-    footer = "Mogelijk gemaakt door <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, en <a href=\"https://getdoks.org/\">Doks</a>"
+    footer = 'Mogelijk gemaakt door <a href="https://www.netlify.com/">Netlify</a>, <a href="https://gohugo.io/">Hugo</a>, en <a href="https://getdoks.org/">Doks</a>'
-    alertText = "Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\">Bekijk Doks v0.2</a>"
+    alertText = 'Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.2/">Bekijk Doks v0.2</a>'

config/_default/module.toml

@@ -1,53 +1,28 @@
+# mounts
+## archetypes
 [[mounts]]
-  source = "config/_default/hyas"
+  source = "node_modules/@hyas/doks-core/archetypes"
-  target = "data"
+  target = "archetypes"
 
+[[mounts]]
+  source = "archetypes"
+  target = "archetypes"
+
+## assets
 [[mounts]]
   source = "node_modules/@hyas/core/assets"
   target = "assets"
 
-[[mounts]]
-  source = "node_modules/@hyas/core/layouts"
-  target = "layouts"
-
-[[mounts]]
-  source = "node_modules/@hyas/seo/layouts"
-  target = "layouts"
-
 [[mounts]]
   source = "node_modules/@hyas/images/assets"
   target = "assets"
   excludeFiles = "/scss/**.scss"
 
-[[mounts]]
-  source = "node_modules/@hyas/images/layouts"
-  target = "layouts"
-
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/archetypes"
-  target = "archetypes"
-
 [[mounts]]
   source = "node_modules/@hyas/doks-core/assets"
   target = "assets"
   excludeFiles = ["scss/common/_variables-custom.scss", "scss/common/_custom.scss"]
 
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/data"
-  target = "data"
-
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/i18n"
-  target = "i18n"
-
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/layouts"
-  target = "layouts"
-
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/static"
-  target = "static"
-
 [[mounts]]
   source = "node_modules/flexsearch"
   target = "assets/js/vendor/flexsearch"
@@ -65,45 +40,66 @@
   target = "assets/svgs/tabler-icons"
 
 [[mounts]]
-  source = "assets/svgs"
+  source = "assets"
-  target = "assets/svgs"
+  target = "assets"
+
+## content
+[[mounts]]
+  source = "content"
+  target = "content"
+
+## data
+[[mounts]]
+  source = "node_modules/@hyas/doks-core/data"
+  target = "data"
+
+[[mounts]]
+  source = "config/_default/hyas"
+  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 = "themes/my-doks-theme/assets" 
-  target = "assets"
-
-[[mounts]]
-  source = "themes/my-doks-theme/layouts"
-  target = "layouts"
-
-[[mounts]]
-  source = "archetypes"
-  target = "archetypes"
-
-[[mounts]]
-  source = "assets"
-  target = "assets"
-
-[[mounts]]
-  source = "content"
-  target = "content"
-
-[[mounts]]
-  source = "data"
-  target = "data"
-
-[[mounts]]
-  source = "i18n"
-  target = "i18n"
-
 [[mounts]]
   source = "layouts"
   target = "layouts"
 
+## static
+[[mounts]]
+  source = "node_modules/@hyas/doks-core/static"
+  target = "static"
+
 [[mounts]]
   source = "static"
-  target = "static"
+  target = "static"

config/_default/params.toml

@@ -0,0 +1,134 @@
+# Hugo
+title = "My Docs"
+description = "Congrats on setting up a new Doks project!"
+images = ["cover.png"]
+
+# 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"])
+
+  ## 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
+
+  # KaTex
+  katex = 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

config/_default/params.yml

@@ -1,67 +0,0 @@
-# Images (@hyas/images)
-image:
-  ## General
-  type: page # page (default) or global
-  widths: [600, 900, 1300] # [600, 900, 1300] (default)
-  densities: [1,2] # [1,2] (default)
-  formats: [original, webp] # [original, webp] (default)
-  provider: null # null (default) or netlify
-  loading: lazysizes # auto (default), lazy, or lazysizes
-  class: "img-fluid blur-up" # img-fluid (default)
-  output: picture # picture (default), figure, or img
-  noscript: false # false (default) or true
-
-  ## Placeholder
-  placeholder: lqip # null (default), lqip, dominant, or [black, [gray-100..gray-900], white]
-  lqip_div_factor: 5 # 5 (default)
-  lqip_blur_amount: 5 # 5 (default)
-  gif_div_factor: 10 # 10 (default)
-
-  ## Figure
-  target: "_blank" # _blank (default)
-  rel: "noopener, noreferrer" # noopener, noreferrer (default)
-  figure_class: "figure" # figure (default)
-  figure_image_class: "figure-img img-fluid blur-up" # "figure-img img-fluid" (default)
-  figcaption_class: figure-caption # figure-caption (default)
-  figcaption_title_h: 4 # 4 (default)
-  attr_link_target: "_blank" # _blank (default)
-  attr_link_rel: "noopener, noreferrer" # noopener, noreferrer (default)
-
-  ## Render hook
-  render_hook: true # false (default) or true
-  render_hook_wrapper_class: img-wrapper # img-wrapper (default)
-
-  ## Shortcode
-  shortcode_wrapper_class: img-wrapper # img-wrapper (default)
-
-  ## Debugging
-  suppress_width_warning: false # false (default) or true
-  debug: false # false (default) or true
-
-# SEO (@hyas/seo)
-seo:
-  description: ""
-  generate:
-    title: true
-    meta: true
-    twitter: true
-    og: true
-    jsonld:
-      article: true
-      breadcrumbs: true
-  title_tag:
-    separator: "|"
-    home_text: ""
-  og_article_types: [post, posts, blog, news, article, articles, event, events, course, courses]
-  jsonld_article_types: [article, articles]
-  jsonld_news_article_types: [news, updates]
-  jsonld_blog_posting_types: [post, posts, blog]
-  image: "/images/hyas-schema-image.png" 
-  private: false
-
-# Inline SVG (@hyas/inline-svg)
-inline_svg:
-  icon_set_dir: "tabler-icons" # tabler-icons (default)
-
-# mainSections
-mainSections: [docs]

config/postcss.config.js

@@ -6,52 +6,47 @@ module.exports = {
   plugins: [
     autoprefixer(),
     purgecss({
-      content: [
+      content: [ './hugo_stats.json' ],
-        './node_modules/@hyas/*/layouts/**/*.html',
+      extractors: [
-        './themes/*/layouts/**/*.html',
+        {
-        './layouts/**/*.html',
+          extractor: (content) => {
-        './content/**/*.html',
+            const els = JSON.parse(content).htmlElements;
-        './content/**/*.md',
+            return els.tags.concat(els.classes, els.ids);
+          },
+          extensions: ['json'],
+        },
+      ],
+      dynamicAttributes: [
+        'aria-expanded',
+        'data-bs-popper',
+        'data-bs-target',
+        'data-bs-theme',
+        'data-dark-mode',
+        'data-global-alert',
+        'data-pane',             // tabs.js
+        'data-popper-placement',
+        'data-sizes',
+        'data-toggle-tab',       // tabs.js
+        'id',
+        'size',
+        'type',
       ],
       safelist: [
-        'lazyloaded',
+        'active',
-        'table',
+        'btn-clipboard',         // clipboards.js
-        'thead',
+        'clipboard',             // clipboards.js
-        'tbody',
+        'disabled',
-        'tr',
+        'hidden',
-        'th',
+        'modal-backdrop',        // search-modal.js
-        'td',
+        'selected',              // search-modal.js
-        'h1',
+        'show',
-        'h2',
-        'h3',
-        'h4',
-        'h5',
-        'alert-link',
-        'container-lg',
-        'container-fluid',
-        'offcanvas-backdrop',
         'img-fluid',
-        'lazyload',
         'blur-up',
-        'figcaption',
+        'lazyloaded',
-        'dt',
-        'dd',
-        'showing',
-        'hiding',
         ...whitelister([
-          './node_modules/@hyas/core/assets/scss/app.scss',
+          './assets/scss/**/*.css',
-          './node_modules/@hyas/doks-core/assets/scss/common/_global.scss',
+          './assets/scss/**/*.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_alerts.scss',
+          './node_modules/katex/dist/katex.css',
-          './node_modules/@hyas/doks-core/assets/scss/components/_buttons.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_callouts.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_code.scss',
-          // './node_modules/@hyas/doks-core/assets/scss/components/_diagrams.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_modals.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_syntax.scss',
-          './node_modules/@hyas/doks-core/assets/scss/components/_search.scss',
-          './node_modules/@hyas/doks-core/assets/scss/common/_dark.scss',
-          './node_modules/bootstrap/scss/_dropdown.scss',
-          // './node_modules/katex/dist/katex.css',
         ]),
       ],
     }),

content/_index.md

@@ -5,5 +5,9 @@ lead: "Congrats on setting up a new Doks project!"
 date: 2023-09-07T16:33:54+02:00
 lastmod: 2023-09-07T16:33:54+02:00
 draft: false
-images: []
+seo:
+ title: "Welcome to Doks" # custom title (optional)
+ description: "" # custom description (recommended)
+ canonical: "" # custom canonical URL (optional)
+ noindex: false # false (default) or true
 ---

content/blog/_index.md

@@ -6,10 +6,14 @@ date: 2023-09-07T16:21:44+02:00
 lastmod: 2023-09-07T16:21:44+02:00
 draft: false
 weight: 50
-images: []
 categories: []
 tags: []
 contributors: []
 pinned: false
 homepage: false
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---

content/blog/example.md

@@ -1,15 +0,0 @@
----
-title: "Example Post"
-description: ""
-summary: ""
-date: 2023-09-07T16:27:22+02:00
-lastmod: 2023-09-07T16:27:22+02:00
-draft: false
-weight: 50
-images: []
-categories: []
-tags: []
-contributors: []
-pinned: false
-homepage: false
----

content/blog/example/index.md

@@ -0,0 +1,19 @@
+---
+title: "Example Post"
+description: "Just an example post."
+summary: ""
+date: 2023-09-07T16:27:22+02:00
+lastmod: 2023-09-07T16:27:22+02:00
+draft: false
+weight: 50
+categories: []
+tags: []
+contributors: []
+pinned: false
+homepage: false
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
+---

content/docs/_index.md

@@ -5,11 +5,15 @@ summary: ""
 date: 2023-09-07T16:12:03+02:00
 lastmod: 2023-09-07T16:12:03+02:00
 draft: false
-images: []
 menu:
   docs:
     parent: ""
     identifier: "docs-9602b15bad02600f3883f55e2ade6b81"
 weight: 999
 toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---

content/docs/guides/_index.md

@@ -5,11 +5,15 @@ summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00
 draft: false
-images: []
 menu:
   docs:
     parent: ""
     identifier: "guides-4e0d0e0f89f7decc11eaad4ae9193018"
 weight: 800
 toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---

content/docs/guides/example.md

@@ -1,17 +1,21 @@
 ---
 title: "Example Guide"
-description: ""
+description: "Guides lead a user through a specific task they want to accomplish, often with a sequence of steps."
 summary: ""
 date: 2023-09-07T16:04:48+02:00
 lastmod: 2023-09-07T16:04:48+02:00
 draft: false
-images: []
 menu:
   docs:
     parent: ""
     identifier: "example-6a1a6be4373e933280d78ea53de6158e"
 weight: 810
 toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---
 
 Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.

content/docs/reference/_index.md

@@ -5,11 +5,15 @@ summary: ""
 date: 2023-09-07T16:12:37+02:00
 lastmod: 2023-09-07T16:12:37+02:00
 draft: false
-images: []
 menu:
   docs:
     parent: ""
     identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd"
 weight: 900
 toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---

content/docs/reference/example.md

@@ -1,17 +1,21 @@
 ---
 title: "Example Reference"
-description: ""
+description: "Reference pages are ideal for outlining how things work in terse and clear terms."
 summary: ""
 date: 2023-09-07T16:13:18+02:00
 lastmod: 2023-09-07T16:13:18+02:00
 draft: false
-images: []
 menu:
   docs:
     parent: ""
     identifier: "example-ee51430687e728ba6e68dea3359133ad"
 weight: 910
 toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---
 
 Reference pages are ideal for outlining how things work in terse and clear terms. Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what your documenting.

content/privacy.md

@@ -5,6 +5,10 @@ summary: ""
 date: 2023-09-07T17:19:07+02:00
 lastmod: 2023-09-07T17:19:07+02:00
 draft: false
-images: []
 type: "legal"
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
 ---

hugo_stats.json

@@ -0,0 +1,256 @@
+{
+  "htmlElements": {
+    "tags": [
+      "a",
+      "article",
+      "aside",
+      "body",
+      "button",
+      "circle",
+      "code",
+      "details",
+      "div",
+      "footer",
+      "form",
+      "g",
+      "h1",
+      "h2",
+      "h3",
+      "h5",
+      "head",
+      "header",
+      "html",
+      "input",
+      "kbd",
+      "label",
+      "li",
+      "line",
+      "link",
+      "main",
+      "meta",
+      "nav",
+      "noscript",
+      "p",
+      "path",
+      "script",
+      "section",
+      "small",
+      "span",
+      "strong",
+      "style",
+      "summary",
+      "svg",
+      "template",
+      "time",
+      "title",
+      "ul"
+    ],
+    "classes": [
+      "DocSearch-Label",
+      "active",
+      "align-items-center",
+      "anchor",
+      "bg-dots",
+      "blog",
+      "blog-header",
+      "btn",
+      "btn-close",
+      "btn-cta",
+      "btn-lg",
+      "btn-link",
+      "btn-primary",
+      "btn-toggle",
+      "btn-toggle-nav",
+      "card",
+      "card-body",
+      "card-list",
+      "categories",
+      "col-lg-10",
+      "col-lg-11",
+      "col-lg-12",
+      "col-lg-5",
+      "col-lg-8",
+      "col-lg-9",
+      "col-md-12",
+      "col-xl-3",
+      "col-xl-4",
+      "col-xl-8",
+      "col-xl-9",
+      "collapse",
+      "collapsed",
+      "collapsible-sidebar",
+      "container",
+      "container-fluid",
+      "container-lg",
+      "content",
+      "contributors",
+      "created-date",
+      "d-flex",
+      "d-lg-block",
+      "d-lg-none",
+      "d-md-block",
+      "d-md-none",
+      "d-none",
+      "d-xl-block",
+      "d-xl-none",
+      "docs",
+      "docs-content",
+      "docs-link",
+      "docs-links",
+      "docs-sidebar",
+      "docs-toc",
+      "doks-sidebar",
+      "error404",
+      "flex-column",
+      "flex-grow-1",
+      "flex-lg-row",
+      "flex-md-row",
+      "flex-row",
+      "flex-sm-row",
+      "flex-xl-nowrap",
+      "footer",
+      "form-control",
+      "form-control-lg",
+      "fs-5",
+      "fw-normal",
+      "h-auto",
+      "h3",
+      "h4",
+      "h5",
+      "home",
+      "icon",
+      "icon-tabler",
+      "icon-tabler-arrow-left",
+      "icon-tabler-arrow-right",
+      "icon-tabler-brand-github",
+      "icon-tabler-clock",
+      "icon-tabler-dots-vertical",
+      "icon-tabler-menu",
+      "icon-tabler-moon",
+      "icon-tabler-search",
+      "icon-tabler-sun",
+      "icon-tabler-x",
+      "justify-content-between",
+      "justify-content-center",
+      "justify-content-end",
+      "justify-content-start",
+      "lead",
+      "list",
+      "list-inline",
+      "list-inline-item",
+      "list-unstyled",
+      "list-view",
+      "mb-0",
+      "mb-1",
+      "me-2",
+      "me-auto",
+      "me-lg-1",
+      "me-lg-3",
+      "message",
+      "modal",
+      "modal-body",
+      "modal-content",
+      "modal-dialog",
+      "modal-dialog-scrollable",
+      "modal-footer",
+      "modal-fullscreen-md-down",
+      "modal-header",
+      "modal-title",
+      "ms-2",
+      "ms-3",
+      "ms-lg-2",
+      "mt-3",
+      "mt-n3",
+      "mx-2",
+      "mx-auto",
+      "my-3",
+      "nav",
+      "nav-item",
+      "nav-link",
+      "navbar",
+      "navbar-brand",
+      "navbar-expand-lg",
+      "navbar-nav",
+      "offcanvas",
+      "offcanvas-body",
+      "offcanvas-end",
+      "offcanvas-header",
+      "offcanvas-start",
+      "offcanvas-title",
+      "order-3",
+      "order-lg-4",
+      "p-0",
+      "p-2",
+      "page-footer-meta",
+      "page-links",
+      "page-nav",
+      "pb-1",
+      "pb-3",
+      "position-relative",
+      "privacy",
+      "px-0",
+      "query-no-results",
+      "reading-time",
+      "rounded",
+      "rounded-pill",
+      "row",
+      "search-form",
+      "search-input",
+      "search-loading",
+      "search-no-recent",
+      "search-no-results",
+      "search-result",
+      "search-results",
+      "search-text",
+      "section",
+      "section-features",
+      "section-md",
+      "show",
+      "single",
+      "small",
+      "social-link",
+      "status",
+      "sticky-top",
+      "stretched-link",
+      "submitted",
+      "tags",
+      "taxonomy",
+      "text-body",
+      "text-body-secondary",
+      "text-center",
+      "text-decoration-none",
+      "text-end",
+      "text-lg-end",
+      "text-lg-start",
+      "text-muted",
+      "text-reset",
+      "title",
+      "title-submitted",
+      "toc-mobile",
+      "visually-hidden",
+      "w-100",
+      "wrap"
+    ],
+    "ids": [
+      "TableOfContents",
+      "buttonColorMode",
+      "doks-docs-nav",
+      "further-reading",
+      "offcanvasNavMain",
+      "offcanvasNavMainLabel",
+      "offcanvasNavSection",
+      "offcanvasNavSectionLabel",
+      "query",
+      "search-form",
+      "searchModal",
+      "searchModalLabel",
+      "searchResults",
+      "searchToggleDesktop",
+      "searchToggleMobile",
+      "section-45389ee90014e0938cb09409b9a8794d",
+      "section-63d5049791d9d79d86e9a108b0a999ca",
+      "socialMenu",
+      "toc"
+    ]
+  }
+}

i18n/de.toml

@@ -1,8 +0,0 @@
-[get-started]
-other = "Loslegen"
-
-[on-this-page]
-other = "Auf dieser Seite"
-
-[videoUnsupported]
-other = "Ihr Browser unterstützt keine integrierten Videos, aber keine Sorge, Sie können <a href=\"{{ .RelPermalink }}\">es herunterladen</a> und mit Ihrem Lieblings-Videoplayer ansehen!"

i18n/en.toml

@@ -1,32 +0,0 @@
-[search_placeholder]
-other = "Search"
-
-[search_title]
-other = "Search"
-
-[search_loading]
-other = "Loading search index…"
-
-[search_no_recent]
-other = "No recent searches"
-
-[search_no_results]
-other = "No results"
-
-[get-started]
-other = "Example Guide"
-
-[on-this-page]
-other = "On this page"
-
-[404-title]
-other = "Page not found :("
-
-[404-text]
-other = "The page you are looking for doesn't exist or has been moved."
-
-[browse]
-other = "Browse"
-
-[videoUnsupported]
-other = "Your browser doesn't support embedded videos, but don't worry, you can <a href=\"{{ .RelPermalink }}\">download it</a> and watch it with your favorite video player!"

i18n/nl.toml

@@ -1,17 +0,0 @@
-[search_title]
-other = "Zoeken"
-
-[get-started]
-other = "Aan de slag"
-
-[on-this-page]
-other = "Op deze pagina"
-
-[404-title]
-other = "Pagina niet gevonden :("
-
-[404-text]
-other = "De gezochte pagina bestaat niet of deze is verplaatst."
-
-[browse]
-other = "Browse"

integrations/doks-core/README.md

@@ -1,13 +0,0 @@
-# Customizations
-
-Customizations for the [Doks Core](https://github.com/gethyas/doks-core) integration go here.
-
-## Usage
-
-Copy the file(s) you'd like to override from `./node_modules/@hyas/doks-core/` and paste to `./integrations/doks-core/`. Make sure to keep the folder structure.
-
-Supported folders are: `archetypes`, `assets` and `layouts`.
-
-## Mounting settings
-
-If needed, you can change the mountings settings in `./config/_default/module.toml`. See also the Hugo docs: [Module Config: mounts](https://gohugo.io/hugo-modules/configuration/#module-config-mounts).

integrations/images/README.md

@@ -1,13 +0,0 @@
-# Customizations
-
-Customizations for the [Images](https://github.com/gethyas/images) integration go here.
-
-## Usage
-
-Copy the file(s) you'd like to override from `./node_modules/@hyas/images/` and paste to `./integrations/images/`. Make sure to keep the folder structure.
-
-Supported folders are: `layouts`.
-
-## Mounting settings
-
-If needed, you can change the mountings settings in `./config/_default/module.toml`. See also the Hugo docs: [Module Config: mounts](https://gohugo.io/hugo-modules/configuration/#module-config-mounts).

integrations/seo/README.md

@@ -1,13 +0,0 @@
-# Customizations
-
-Customizations for the [SEO](https://github.com/gethyas/seo) integration go here.
-
-## Usage
-
-Copy the file(s) you'd like to override from `./node_modules/@hyas/seo/` and paste to `./integrations/seo/`. Make sure to keep the folder structure.
-
-Supported folders are: `layouts`.
-
-## Mounting settings
-
-If needed, you can change the mountings settings in `./config/_default/module.toml`. See also the Hugo docs: [Module Config: mounts](https://gohugo.io/hugo-modules/configuration/#module-config-mounts).

layouts/index.html

@@ -6,7 +6,7 @@
     </div>
     <div class="col-lg-9 col-xl-8 text-center">
       <p class="lead">{{ .Params.lead | safeHTML }}</p>
-      <a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Data.doks.docsVersioning }}{{ site.Data.doks.docsVersion }}/{{ end }}guides/example-guide/" role="button">{{ i18n "get-started" }}</a>
+      <a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}guides/example-guide/" role="button">{{ i18n "get_started" }}</a>
       {{ .Content }}
     </div>
   </div>
@@ -14,7 +14,7 @@
 {{ end }}
 
 {{ define "sidebar-prefooter" }}
-  {{ if site.Data.doks.backgroundDots -}}
+  {{ if site.Params.doks.backgroundDots -}}
   <div class="d-flex justify-content-start">
     <div class="bg-dots"></div>
   </div>
@@ -46,12 +46,12 @@
 {{ end }}
 
 {{ define "sidebar-footer" }}
-{{ if site.Data.doks.sectionFooter -}}
+{{ if site.Params.doks.sectionFooter -}}
 <section class="section section-md container-fluid bg-light">
   <div class="row justify-content-center text-center">
     <div class="col-lg-7">
       <h2 class="mt-2">Start building with Doks today</h2>
-      <a class="btn btn-primary rounded-pill px-4 my-2" href="/docs/{{ if site.Data.doks.docsVersioning }}{{ site.Data.doks.docsVersion }}/{{ end }}prologue/introduction/" role="button">{{ i18n "get-started" }}</a>
+      <a class="btn btn-primary rounded-pill px-4 my-2" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}prologue/introduction/" role="button">{{ i18n "get-started" }}</a>
     </div>
   </div>
 </section>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "doks",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Doks theme",
   "author": "Hyas",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "version": "auto-changelog -p && git add CHANGELOG.md"
   },
   "dependencies": {
-    "@hyas/doks-core": "^1.0.7"
+    "@hyas/doks-core": "^1.1.0"
   },
   "devDependencies": {
     "auto-changelog": "^2.4.0"

static/site.webmanifest

@@ -1 +0,0 @@
-{"name":"Doks Theme","short_name":"Doks","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#fff","background_color":"#fff","display":"standalone"}

themes/my-doks-theme/README.md

@@ -1,13 +0,0 @@
-# Customizations
-
-Customizations for the [Doks Core](https://github.com/gethyas/doks-core) integration go here.
-
-## Usage
-
-Copy the file(s) you'd like to override from `./node_modules/@hyas/doks-core/` and paste to `./themes/my-doks-theme/`. Make sure to keep the folder structure.
-
-Supported folders are: `archetypes`, `assets`, `data`, and `layouts`.
-
-## Mounting settings
-
-If needed, you can change the mountings settings in `./config/_default/module.toml`. See also the Hugo docs: [Module Config: mounts](https://gohugo.io/hugo-modules/configuration/#module-config-mounts).