feat: update for Doks v0.5.0

README.md

@@ -31,7 +31,7 @@
   </a>
 </p>
 
-![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/tn.png)
+![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/doks.png)
 
 ## Demo
 
@@ -43,7 +43,7 @@ Nine main reasons why you should use Doks:
 
 1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
 
-2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637) by default. Doks removes unused css, prefetches links, and lazy loads images.
+2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=59aafe464a68f8bc30b8e9a636d5b053) by default. Doks removes unused css, prefetches links, and lazy loads images.
 
 3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
 

config/_default/config.toml

@@ -67,53 +67,16 @@ rel  = "sitemap"
 [minify.tdewolff.html]
   keepWhitespace = false
 
-[module]
+[related]
-  [module.hugoVersion]
+  threshold = 80
-    extended = true
+  includeNewer = true
-    min = "0.80.0"
+  toLower = false
-    max = ""
+    [[related.indices]]
-  [[module.mounts]]
+    name = "categories"
-    source = "node_modules/@hyas/doks/archetypes"
+    weight = 100
-    target = "archetypes"
+    [[related.indices]]
-  [[module.mounts]]
+    name = "tags"
-    source = "node_modules/@hyas/doks/assets"
+    weight = 80
-    target = "assets"
+    [[related.indices]]
-#  [[module.mounts]]
+    name = "date"
-#    source = "node_modules/@hyas/doks/content"
+    weight = 10
-#    target = "content"
-  [[module.mounts]]
-    source = "node_modules/@hyas/doks/data"
-    target = "data"
-  [[module.mounts]]
-    source = "node_modules/@hyas/doks/layouts"
-    target = "layouts"
-  [[module.mounts]]
-    source = "node_modules/@hyas/doks/static"
-    target = "static"
-  [[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 = "assets"
-    target = "assets"
-  [[module.mounts]]
-    source = "static"
-    target = "static"
-#  [[module.mounts]]
-#    source = "content"
-#    target = "content"
-  [[module.mounts]]
-    source = "layouts"
-    target = "layouts"
-  [[module.mounts]]
-    source = "archetypes"
-    target = "archetypes"
-  [[module.mounts]]
-    source = "data"
-    target = "data"

config/_default/languages.toml

@@ -4,6 +4,7 @@
   weight = 10
   [en.params]
     languageISO = "EN"
+    languageTag = "en-US"
 
 [de]
   languageName = "German"
@@ -11,6 +12,7 @@
   weight = 15
   [de.params]
     languageISO = "DE"
+    languageTag = "de-DE"
 
 [nl]
   languageName = "Nederlands"
@@ -18,6 +20,7 @@
   weight = 20
   [nl.params]
     languageISO = "NL"
+    languageTag = "nl-NL"
     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"

config/_default/module.toml

@@ -0,0 +1,68 @@
+[hugoVersion]
+  extended = true
+  min = "0.80.0"
+  max = ""
+
+[[mounts]]
+  source = "node_modules/@hyas/doks/archetypes"
+  target = "archetypes"
+
+[[mounts]]
+  source = "node_modules/@hyas/doks/assets"
+  target = "assets"
+
+#  [[mounts]]
+#    source = "node_modules/@hyas/doks/content"
+#    target = "content"
+
+[[mounts]]
+  source = "node_modules/@hyas/doks/data"
+  target = "data"
+
+[[mounts]]
+  source = "node_modules/@hyas/doks/layouts"
+  target = "layouts"
+
+[[mounts]]
+  source = "node_modules/@hyas/doks/static"
+  target = "static"
+
+[[mounts]]
+  source = "node_modules/flexsearch"
+  target = "assets/js/vendor/flexsearch"
+
+[[mounts]]
+  source = "node_modules/katex"
+  target = "assets/js/vendor/katex"
+
+[[mounts]]
+  source = "node_modules/mermaid"
+  target = "assets/js/vendor/mermaid"
+
+[[mounts]]
+  source = "assets"
+  target = "assets"
+
+[[mounts]]
+  source = "static"
+  target = "static"
+
+#  [[mounts]]
+#    source = "content"
+#    target = "content"
+
+[[mounts]]
+  source = "layouts"
+  target = "layouts"
+
+[[mounts]]
+  source = "archetypes"
+  target = "archetypes"
+
+[[mounts]]
+  source = "data"
+  target = "data"
+
+[[mounts]]
+  source = "node_modules/@hyas/images/layouts"
+  target = "layouts"

config/_default/params.toml

@@ -45,7 +45,7 @@ siteLinksSearchBox = false
 ## Chrome Browser
 themeColor = "#fff"
 
-# Images
+# Images - Temporarily left in place for backward compatibility
 quality = 85
 bgColor = "#fff"
 landscapePhotoWidths = [900, 800, 700, 600, 500]
@@ -53,6 +53,17 @@ portraitPhotoWidths = [800, 700, 600, 500]
 lqipWidth = "20x"
 smallLimit = "300"
 
+# Images
+imageResponsive = true
+imageConvertTo = "webp"
+imageImageSizes = ["480","720","1080","1280","1600","2048"]
+singleSize = false
+imageAddClass = "img-fluid lazyload blur-up"
+
+### Image template
+defaultImage = "default-image.png" # put in `./assets/images/`
+fillImage = "1270x740 Center" # normalize image size
+
 # 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>"
 
@@ -75,11 +86,16 @@ docsRepoSubPath = ""
 editPage = false
 lastMod = false
 
+[sections]
+  sectionNav = ["docs", "guides"]
+
 [options]
   lazySizes = true
   clipBoard = true
   instantPage = true
   flexSearch = true
+  searchSectionsShow = []
+  searchSectionsIndex = []
   darkMode = true
   bootStrapJs = true
   breadCrumb = false
@@ -88,6 +104,9 @@ lastMod = false
   multilingualMode = false
   docsVersioning = false
   fullWidth = false
+  navbarSticky = true
+  toTopButton = false
+  scrollSpy = false # experimental; needs Bootstrap >= 5.2.0-beta1
 
 [menu]
   [menu.section]

i18n/de.yaml

@@ -0,0 +1,5 @@
+- id: get-started
+  translation: "Loslegen"
+
+- id: on-this-page
+  translation: "Auf dieser Seite"

i18n/en.toml

@@ -1,2 +0,0 @@
-[get-started]
-   other = "Get Started"

i18n/en.yaml

@@ -0,0 +1,17 @@
+- id: get-started
+  translation: "Get Started"
+
+- id: on-this-page
+  translation: "On this page"
+
+- id: search-text
+  translation: "Search docs..."
+
+- id: 404-title
+  translation: "Page not found :("
+
+- id: 404-text
+  translation: "The page you are looking for doesn't exist or has been moved."
+
+- id: browse
+  translation: "Browse"

i18n/nl.toml

@@ -1,2 +0,0 @@
-[get-started]
-   other = "Aan de slag"

i18n/nl.yaml

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

layouts/index.html

@@ -23,7 +23,7 @@
       </div>
       <div class="col-lg-5">
         <h2 class="h4">Fast by default ⚡️</h2>
-        <p>Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthouse</a> by default. Doks removes unused css, prefetches links, and lazy loads images.</p>
+        <p>Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=59aafe464a68f8bc30b8e9a636d5b053">Google Lighthouse</a> by default. Doks removes unused css, prefetches links, and lazy loads images.</p>
       </div>
       <div class="col-lg-5">
         <h2 class="h4">SEO-ready</h2>

layouts/partials/head/custom-head.html

@@ -0,0 +1 @@
+<!-- Custom head -->

netlify.toml

@@ -3,8 +3,8 @@
   functions = "functions"
 
 [build.environment]
-  NODE_VERSION = "16.15.0"
+  NODE_VERSION = "16.16.0"
-  NPM_VERSION = "8.5.5"
+  NPM_VERSION = "8.11.0"
 
 [context.production]
   command = "npm run build"

package.json

@@ -1,9 +1,9 @@
 {
   "name": "doks-child-theme",
   "description": "Doks child theme",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "engines": {
-		"node": ">=16.15.0"
+    "node": ">=16.16.0"
   },
   "browserslist": [
     "defaults"
@@ -38,33 +38,34 @@
     "version": "auto-changelog -p && git add CHANGELOG.md"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17",
+    "@babel/cli": "^7.18",
-    "@babel/core": "^7.17",
+    "@babel/core": "^7.18",
-    "@babel/preset-env": "^7.17",
+    "@babel/preset-env": "^7.18",
     "@fullhuman/postcss-purgecss": "^4.1",
-    "@hyas/doks": "^0.4",
+    "@hyas/doks": "^0.5",
+    "@hyas/images": "^0.2.1",
     "auto-changelog": "^2.4.0",
     "autoprefixer": "^10.4",
     "bootstrap": "^5.1",
     "clipboard": "^2.0",
-    "eslint": "^8.15",
+    "eslint": "^8.19",
     "exec-bin": "^1.0.0",
-    "hugo-installer": "^3.1",
     "flexsearch": "^0.7.21",
     "highlight.js": "^11.5",
+    "hugo-installer": "^3.1",
     "instant.page": "^5.1",
-    "katex": "^0.15",
+    "katex": "^0.16",
     "lazysizes": "^5.3",
     "markdownlint-cli2": "^0.4.0",
-    "netlify-plugin-submit-sitemap": "^0.3.0",
+    "netlify-plugin-submit-sitemap": "^0.4.0",
     "postcss": "^8.4",
-    "postcss-cli": "^9.1",
+    "postcss-cli": "^10.0",
     "purgecss-whitelister": "^2.4",
     "shx": "^0.3",
-    "stylelint": "^14.8",
+    "stylelint": "^14.9",
-    "stylelint-config-standard-scss": "^3.0"
+    "stylelint-config-standard-scss": "^4.0"
   },
   "otherDependencies": {
-    "hugo": "0.99.0"
+    "hugo": "0.101.0"
   }
 }