feat: update for Doks 1.0

config/_default/hugo.toml

@@ -1,4 +1,4 @@
-title = "Doks"
+title = "My Docs"
 baseurl = "/"
 canonifyURLs = false
 disableAliases = true
@@ -58,6 +58,7 @@ rel  = "sitemap"
 
 [permalinks]
   blog = "/blog/:slug/"
+  docs = "/docs/:sections[1:]/:slug/"
 # docs = "/docs/1.0/:sections[1:]/:slug/"
 
 [minify.tdewolff.html]
@@ -78,8 +79,8 @@ rel  = "sitemap"
     weight = 10
 
 [imaging]
-  anchor = 'Smart'
-  bgColor = '#fff'
-  hint = 'photo'
-  quality = 90
-  resampleFilter = 'Lanczos'
+  anchor = "Smart"
+  bgColor = "#ffffff"
+  hint = "photo"
+  quality = 75
+  resampleFilter = "Box"

config/_default/hyas/doks.toml

@@ -13,7 +13,8 @@ navBarButtonText = "Get started"
 
 # FlexSearch
 flexSearch = true # true (default) or false
-indexPages = [] # [] (all regular pages, default) or list of sections (e.g. ["blog", "guides"])
+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
@@ -24,7 +25,7 @@ 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/doks-1/">Doks version 1.0 just shipped!</a>'
+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
@@ -38,13 +39,14 @@ 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 = true # true (default)  or false
+headerBar = false # false (default) or true
 backgroundDots = true # true (default)  or false
 
 # Homepage
@@ -54,10 +56,10 @@ sectionFooter = false # false (default) or true
 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>"
+footer = "Brought to you by <a class=\"text-muted\" href=\"https://gethyas.com/\">Hyas</a>"
 
-# kaTex
-kaTex = false
+# KaTex
+katex = false
 
 # Repository
 editPage = false # false (default) or true

config/_default/menus/menus.en.toml

@@ -30,53 +30,21 @@
 
 [[main]]
   name = "Docs"
-  url = "/docs/start-here/getting-started/"
+  url = "/docs/guides/example-guide/"
 # url = "/docs/1.0/prologue/introduction/"
   weight = 10
 
-[[main]]
-  name = "Resources"
-  weight = 20
-  identifier = "resources"
-  url = "/"
-
-[[main]]
-  name = "Integrations"
-  weight = 21
-  identifier = "integrations"
-  url = "https://deploy-preview-256--gethyas.netlify.app/plugins/"
-  parent = "resources"
-
-[[main]]
-  name = "Tutorials"
-  weight = 21
-  identifier = "tutorials"
-  url = "https://getdoks.org/docs/tutorial/introduction/"
-  parent = "resources"
-
-[[main]]
-  name = "Discussions"
-  weight = 23
-  identifier = "discussions"
-  url = "https://github.com/h-enk/doks/discussions"
-  parent = "resources"
-
 [[main]]
   name = "Blog"
   url = "/blog/"
   weight = 30
 
-[[main]]
-  name = "About"
-  url = "/about/"
-  weight = 40
-
 # [[social]]
 #   name = "Twitter"
-#   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-twitter" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M22 4.01c-1 .49 -1.98 .689 -3 .99c-1.121 -1.265 -2.783 -1.335 -4.38 -.737s-2.643 2.06 -2.62 3.737v1c-3.245 .083 -6.135 -1.395 -8 -4c0 0 -4.182 7.433 4 11c-1.872 1.247 -3.739 2.088 -6 2c3.308 1.803 6.913 2.423 10.034 1.517c3.58 -1.04 6.522 -3.723 7.651 -7.742a13.84 13.84 0 0 0 .497 -3.753c0 -.249 1.51 -2.772 1.818 -4.013z"></path></svg>'
+#   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-x" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M4 4l11.733 16h4.267l-11.733 -16z"></path><path d="M4 20l6.768 -6.768m2.46 -2.46l6.772 -6.772"></path></svg>'
 #   url = "https://twitter.com/getdoks"
 #   weight = 10
-
+# 
 # [[social]]
 #   name = "Discord"
 #   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-discord" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M8 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M14 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M8.5 17c0 1 -1.356 3 -1.832 3c-1.429 0 -2.698 -1.667 -3.333 -3c-.635 -1.667 -.476 -5.833 1.428 -11.5c1.388 -1.015 2.782 -1.34 4.237 -1.5l.975 1.923a11.913 11.913 0 0 1 4.053 0l.972 -1.923c1.5 .16 3.043 .485 4.5 1.5c2 5.667 2.167 9.833 1.5 11.5c-.667 1.333 -2 3 -3.5 3c-.5 0 -2 -2 -2 -3"></path><path d="M7 16.5c3.5 1 6.5 1 10 0"></path></svg>'
@@ -86,16 +54,16 @@
 [[social]]
   name = "GitHub"
   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
-  url = "https://github.com/h-enk/doks"
+  url = "https://github.com/gethyas/doks"
   post = "v0.1.0"
   weight = 30
 
 [[footer]]
-  name = "Privacy"
+  name = "Privacy Policy"
   url = "/privacy/"
   weight = 10
 
-[[footer]]
-  name = "Terms"
-  url = "/terms/"
-  weight = 20
+# [[footer]]
+#   name = "Terms of Service"
+#   url = "/terms/"
+#   weight = 20

config/_default/module.toml

@@ -31,10 +31,6 @@
   source = "node_modules/@hyas/doks-core/assets"
   target = "assets"
 
-[[mounts]]
-  source = "node_modules/@hyas/doks-core/content"
-  target = "content"
-
 [[mounts]]
   source = "node_modules/@hyas/doks-core/data"
   target = "data"
@@ -75,6 +71,10 @@
   source = "node_modules/@hyas/inline-svg/layouts"
   target = "layouts"
 
+[[mounts]]
+  source = "themes/doks/layouts"
+  target = "layouts"
+
 [[mounts]]
   source = "archetypes"
   target = "archetypes"

config/_default/params.yml

@@ -2,7 +2,7 @@
 image:
   ## General
   type: page # page (default) or global
-  widths: [480, 640, 768, 1024, 1366] # [600, 900, 1300] (default)
+  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
@@ -40,7 +40,7 @@ image:
 
 # SEO (@hyas/seo)
 seo:
-  description: "Doks is a Hyas theme for building custom, production-ready documentation websites."
+  description: ""
   generate:
     title: true
     meta: true
@@ -51,7 +51,7 @@ seo:
       breadcrumbs: true
   title_tag:
     separator: "|"
-    home_text: "Modern Documentation Theme"
+    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]