🔍 update DocSearch configuration; 🎨 theme update

.github/workflows/deploy-preview.yaml

@@ -42,6 +42,8 @@ jobs:
           filters: |
             docs:
               - 'content/docs/**'
+            config:
+              - 'docsearch-preview.json'
           base: develop
 
       # Step 3 - Install Hugo (specific version)
@@ -77,8 +79,8 @@ jobs:
     # The type of runner that the job will run on
     runs-on: ubuntu-20.04
     needs: [deploy-preview]
-    # Run job only if there are changes to 'content/docs/**'
-    if: needs.deploy-preview.outputs.docs == 'true'
+    # Run job only if there are changes to 'content/docs/**' or 'docsearch-preview.json'
+    if: needs.deploy-preview.outputs.docs == 'true' || needs.deploy-preview.outputs.config == 'true'
 
     steps:
       # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE

.github/workflows/deploy-production.yaml

@@ -42,6 +42,8 @@ jobs:
           filters: |
             docs:
               - 'content/docs/**'
+            config:
+              - 'docsearch-prod.json'
           base: release
 
       # Step 3 - Install Hugo (specific version)
@@ -75,8 +77,8 @@ jobs:
       # The type of runner that the job will run on
       runs-on: ubuntu-20.04
       needs: [deploy-production]
-      # Run job only if there are changes to 'content/docs/**'
-      if: needs.deploy-production.outputs.docs == 'true'
+      # Run job only if there are changes to 'content/docs/**' or 'docsearch-prod.json'
+      if: needs.deploy-preview.outputs.docs == 'true' || needs.deploy-preview.outputs.config == 'true'
 
       steps:
         # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE

content/docs/contributing/_index.md

@@ -1,7 +1,7 @@
 ---
 weight: 400
 title: "Contributing"
-description: "Find out how to contribute to Lotus Labs."
+description: "How to contribute to Lotus Labs."
 icon: heart_plus
 lead: ""
 date: 2022-10-15T02:21:15+00:00

content/docs/contributing/how-to-contribute.md

@@ -31,8 +31,8 @@ toc: true
 
 ### Create an issue
 
-- [Bug report](https://github.com/colinwilson/lotusdocs.vercel.app/issues/new?template=bug-report---.md)
-- [Feature request](https://github.com/colinwilson/lotusdocs.vercel.app/issues/new?template=feature-request---.md)
+- [Bug report](https://github.com/colinwilson/lotusdocs.dev/issues/new?template=bug-report---.md)
+- [Feature request](https://github.com/colinwilson/lotusdocs.dev/issues/new?template=feature-request---.md)
 
 ## Help others
 

content/docs/feature-guide/_index.md

@@ -1,9 +1,8 @@
 ---
 weight: 210
 title: "Feature Guide"
-description: "A Guide to Using Lotus Docs' Features."
+description: "A Guide to Lotus Docs Features."
 icon: celebration
-lead: ""
 date: 2022-11-22T12:36:15+00:00
 lastmod: 2022-11-22T12:36:15+00:00
 draft: true

content/docs/feature-guide/shortcodes/alerts.md

@@ -13,7 +13,7 @@ toc: true
 
 ## Adding a Page Alert
 
-A page alert can be added to your markdown using the following Hugo shortcode:
+Page alerts can be added to your markdown using the following shortcode:
 
 ```md
 {{</* alert text="This is the default alert. It consists of a default theme colour and icon." /*/>}}

content/docs/getting-started.md

@@ -6,7 +6,7 @@ author = "Colin Wilson"
 title = "Getting Started"
 icon = "rocket_launch"
 # featured_image = ""
-description = "A guide to getting up and running with Lotus Docs"
+description = "A guide to getting up and running with Lotus Docs."
 publishdate = "2022-09-30T05:34:22+01:00"
 tags = ["Beginners","Guide"]
 categories = [""]
@@ -16,7 +16,7 @@ categories = [""]
   site = "@LotusDocs"
   creator = "@LotusDocs"
   title = "Getting started"
-  description = "Getting started with Lotus Docs"
+  description = "Getting started with Lotus Docs."
   image = ""
 
 +++

content/docs/overview.md

@@ -22,7 +22,7 @@ categories = [""]
 +++
 
 {{< alert context="danger" >}}
-Lotus Docs is currently in the very early stages of development and is, therefore, **not** recommended for use in production. You're welcome to test the theme yourself, and contributions to [the project](https://github.com/colinwilson/lotusdocs) a very welcome.
+Lotus Docs is currently in the very early stages of development and, therefore, is **not** recommended for use in production. You're welcome to test the theme yourself, and contributions to [the project](https://github.com/colinwilson/lotusdocs) a very welcome.
 {{< /alert >}}
 
 Welcome to the Lotus Docs user guide. This guide shows you how to start creating technical documentation sites using Lotus Docs, including site customisation and using Lotus Docs' features and templates.
@@ -43,4 +43,4 @@ The site you’re currently reading was built using the Lotus Docs theme! Many o
 
 Lotus Docs is (currently) suited to small or medium technical documentation sets with 100 or fewer pages of docs. That's not to say Lotus Docs won't scale to larger documentation sets, just that its navigation and site structure may not be sufficient for larger data sets without heavy customisation.
 
-The good news is that development to accommodate such sites is progressing. So keep an eye on the [Lotus Docs GitHub repository](https://github.com/colinwilson/lotusdocs) for updates.
+The good news is that development to accommodate such sites is part of the development roadmap. So keep an eye on the [Lotus Docs GitHub repository](https://github.com/colinwilson/lotusdocs) for updates.

content/docs/test_markdown/_index.md

@@ -1,7 +1,7 @@
 ---
 weight: 10000
 title: "Test Markdown"
-description: "Test markdown pages for testing & development purposes. [NOT for public consumption]"
+description: "Test markdown pages for testing & development."
 icon: science
 lead: ""
 date: 2020-10-06T08:49:15+00:00

content/docs/test_markdown/unorthodox.md

@@ -13,7 +13,7 @@ toc: true
 
 ## Shortcode Notifications/Alerts
 
-Various notification styles:
+Various alert notification styles:
 
 {{< alert >}}
 This is the default alert without any options.<br>No `context` or `icon` parameter defined.
@@ -41,7 +41,7 @@ The default <strong>context</strong> icon can be overridden to display no icon b
 {{< alert icon="🌑" context="dark" text="An alert using an emoji (:jack_o_lantern:) instead of the default <strong>context</strong> icon." />}}
 
 {{< alert context="primary">}}
-The Tutorial is intended for novice to intermediate users.
+The Tutorial is intended for beginner to intermediate users.
 
 This next sentence [demonstrates](https://colinwilson.uk) the colour of a link inside an alert box.
 {{< /alert >}}

docsearch-preview.json

@@ -16,15 +16,18 @@
         ".material-icons",
         "#sidebar",
         "#toc",
-        "#breadcrumbs"
+        "#back-to-top"
     ],
     "selectors": {
-        "lvl0": ".docs-content .content-title",
-        "lvl1": ".docs-content .lead",
+        "lvl0": {
+            "selector": ".breadcrumb a:nth-last-child(2)",
+            "default_value": "Documentation"
+        },
+        "lvl1": ".docs-content .content-title .title-text",
         "lvl2": "#content h2",
         "lvl3": "#content h3",
         "lvl4": "#content h4",
         "lvl5": "#content h5",
-        "text": "#content p,#content ul,#content ol,#content .alert,#content blockquote"
+        "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote"
     }
 }

docsearch-prod.json

@@ -16,15 +16,18 @@
         ".material-icons",
         "#sidebar",
         "#toc",
-        "#breadcrumbs"
+        "#back-to-top"
     ],
     "selectors": {
-        "lvl0": ".docs-content .content-title",
-        "lvl1": ".docs-content .lead",
+        "lvl0": {
+            "selector": ".breadcrumb a:nth-last-child(2)",
+            "default_value": "Documentation"
+        },
+        "lvl1": ".docs-content .content-title .title-text",
         "lvl2": "#content h2",
         "lvl3": "#content h3",
         "lvl4": "#content h4",
         "lvl5": "#content h5",
-        "text": "#content p,#content ul,#content ol,#content .alert,#content blockquote"
+        "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote"
     }
 }