Merge branch 'develop' of colinwilson.github.com:colinwilson/lotusdocs.dev into develop

Author: colinwilson

.github/workflows/deploy-preview.yaml

@@ -59,9 +59,9 @@ jobs:
         run: hugo --logLevel info -D -e staging
         env:
           # HUGO_PARAMS_DOCSEARCH_indexName: ${{ secrets.ALGOLIA_INDEX_NAME }}
-          HUGO_PARAMS_DOCSEARCH_appID: ${{ vars.DOCSEARCH_APPID }}
-          HUGO_PARAMS_DOCSEARCH_apiKey: ${{ vars.DOCSEARCH_APIKEY }}
-          HUGO_PARAMS_DOCSEARCH_indexName: ${{ vars.DOCSEARCH_INDEXNAME }}
+          HUGO_PARAMS_DOCSEARCH_appID: ${{ secrets.DOCSEARCH_APP_ID }}
+          HUGO_PARAMS_DOCSEARCH_apiKey: ${{ secrets.DOCSEARCH_PUBLIC_API_KEY }}
+          HUGO_PARAMS_DOCSEARCH_indexName: ${{ secrets.DOCSEARCH_INDEXNAME }}
           HUGO_PARAMS_PLAUSIBLE_dataDomain: ${{ secrets.PLAUSIBLE_DOMAIN }}
           HUGO_GOOGLEANALYTICS: ${{ vars.HUGO_GOOGLEANALYTICS }}
 
@@ -82,6 +82,8 @@ jobs:
             lotusdocs-staging.vercel.app
 
   docsearch-scrape:
+    # The environment this job references
+    environment: Preview
 
     # The type of runner that the job will run on
     runs-on: ubuntu-20.04
@@ -107,6 +109,6 @@ jobs:
         id: docsearch-scrape
         uses: adapttive/algolia-docsearch-action@1.1.1
         env:
-          APPLICATION_ID: ${{ secrets.DOCSEARCH_APP_ID_PREVIEW }}
-          API_KEY: ${{ secrets.DOCSEARCH_WRITE_API_KEY_PREVIEW }}
+          APPLICATION_ID: ${{ secrets.DOCSEARCH_APP_ID }}
+          API_KEY: ${{ secrets.DOCSEARCH_WRITE_API_KEY }}
           CONFIG: ${{ steps.docsearch-config.outputs.config }}

.github/workflows/deploy-production.yaml

@@ -11,7 +11,7 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains two jobs called "deploy-production" and "docsearch-scrape"
+  # This workflow contains two jobs called "deploy-production" and "docsearch-crawl"
   deploy-production:
     # The environment this job references
     environment:
@@ -78,32 +78,30 @@ jobs:
           vercel-args: "--prod --local-config ../vercel.json" #Optional
           working-directory: public
 
-  # docsearch-scrape:
-
-  #     # 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/**' or 'docsearch-prod.json'
-  #     if: |
-  #       needs.deploy-production.outputs.docs == 'true' ||
-  #       needs.deploy-production.outputs.docsearch_config == 'true'
+  docsearch-crawl:
+    # The environment this job references
+    environment: Production
 
-  #     steps:
-  #       # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
-  #       - name: Checkout
-  #         uses: actions/checkout@v3
+    # 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'
 
-  #       # Step 2 - Format and output DocSearch config
-  #       - name: Output formatted docsearch-*.json as config
-  #         id: docsearch-config
-  #         # run: echo "::set-output name=config::$(cat docsearch-preview.json | jq -r tostring)"
-  #         run: echo "config=$(cat docsearch-prod.json | jq -r tostring)" >> $GITHUB_OUTPUT
+    steps:
+      # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
+      - name: Checkout
+        uses: actions/checkout@v3
 
-  #       # Step 3 - Update DocSearch Index only if content files were changed
-  #       - name: Algolia DocSearch Crawl & Index
-  #         id: docsearch-scrape
-  #         uses: adapttive/algolia-docsearch-action@1.1.1
-  #         env:
-  #           APPLICATION_ID: ${{ secrets.DOCSEARCH_APP_ID_PROD }}
-  #           API_KEY: ${{ secrets.DOCSEARCH_WRITE_API_KEY_PROD }}
-  #           CONFIG: ${{ steps.docsearch-config.outputs.config }}
+      # Step 2 -  Perform DocSearch crawl and reindex of the site contents
+      - name: Algolia crawl and reindex
+        uses: algolia/algoliasearch-crawler-github-actions@v1.1.13
+        id: docsearch-crawl
+        with:
+          crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}
+          crawler-name: 'lotusdev'
+          crawler-api-key: ${{ secrets.CRAWLER_API_KEY }}
+          algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}
+          algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}
+          site-url: 'https://lotusdocs.dev/'

content/docs/deployment/platforms/github-pages.md

@@ -21,7 +21,7 @@ GitHub provides free and fast static hosting over SSL for personal, organization
 
 ## Procedure
 
-Use the following steps to get your Lotus Docs site up and running on GitHub Pages.
+Use the following steps to get your Lotus Docs themed site up and running on GitHub Pages.
 
 1. Create a new repo on GitHub e.g. `https://github.com/colinwilson/colinwilson.github.io`
 

content/docs/deployment/platforms/gitlab-pages.md

@@ -11,7 +11,7 @@ toc: true
 
 ## Overview
 
-With [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/), you can publish your Lotus Docs site directly from a repository in GitLab.
+With [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/), you can publish your Lotus Docs themed site directly from a repository in GitLab.
 
 - Use for any personal or business website.
 - Native support for Hugo.
@@ -20,7 +20,7 @@ With [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/), you can pub
 - Connect your custom domains and TLS certificates.
 - Attribute any license to your content.
 
-GitLab makes it easy to build, deploy, and host your Lotus Docs website via their free GitLab Pages service.
+GitLab Pages makes it easy to build, deploy, and host your Lotus Docs website.
 
 ## Prerequisites
 

content/docs/features/feedback-widget.md

@@ -11,7 +11,7 @@ draft: false
 images: []
 ---
 
-The Lotus Docs feedback plugin integrates with Google or Plausible Analytics to allow you to collect visitor feedback on your sites' content.
+The Lotus Docs feedback plugin integrates with Google or Plausible Analytics allowing you to collect visitor feedback on your sites' content.
 
 ![Lotus Docs Emoticon Feedback Widget Screenshot](https://res.cloudinary.com/lotuslabs/image/upload/r_20,c_scale,w_800/v1692841008/Lotus%20Docs/images/lotusdocs_emoticon_feedback_widget_screenshot_rd_v2_mmoxca.webp)
 {.text-center}

content/docs/features/google-analytics.md

@@ -13,7 +13,7 @@ images: []
 
 Lotus Docs utilises Hugo's internal [Google Analytics v4](https://support.google.com/analytics/#topic=9143232) template[^1].
 
-{{< alert context="info" text="Starting **July 1, 2023**, Universal Analytics (UA) was **deprecated** and is [no longer processed](https://support.google.com/analytics/answer/11583528) by Google. Lotus Docs does not include support for UA." />}}
+{{< alert context="info" text="As of **July 1, 2023**, UA (Universal Analytics) was **deprecated**, and is [no longer processed](https://support.google.com/analytics/answer/11583528) by Google. Lotus Docs does **not** support UA." />}}
 
 ## Enabling Google Analytics
 

content/docs/features/plausible-analytics.md

@@ -13,7 +13,7 @@ images: []
 
 [Plausible Analytics](https://plausible.io "Plausible Analytics Website") is a simple, open source, lightweight (< 1 KB), privacy-focused alternative to Google Analytics. Plausible is completely independent, self-funded and bootstrapped. Read more about [Plausible Analytics](https://plausible.io/about).
 
-![Plausible Analytics Dashboard Screenshot](https://res.cloudinary.com/lotuslabs/image/upload/v1673015990/Lotus%20Docs/Social%20Media/plausible-analytics-screenshot_ds_rdd_c6bi3o.webp)
+![Plausible Analytics Dashboard Screenshot](https://res.cloudinary.com/lotuslabs/image/upload/v1738081372/Lotus%20Docs/images/privacy-focused-web-analytics_mec9kp.webp)
 
 ## Why use Plausible Analytics?
 

content/docs/features/syntax-highlighting.md

@@ -13,9 +13,9 @@ images: []
 
 ## Code Highlighters
 
-Lotus Docs supports syntax highlighting by [Prism](https://prismjs.com/) (enabled by default via `param.docs.prism` in `hugo.toml`) or Hugo's built-in code highlighter [Chroma](https://github.com/alecthomas/chroma).
+Lotus Docs supports syntax highlighting using [Prism](https://prismjs.com/) (enabled by default via `param.docs.prism` in `hugo.toml`) or Hugo's built-in code highlighter [Chroma](https://github.com/alecthomas/chroma).
 
-Fenced code blocks (code enclosed by triple backticks above and below) that specify a code language (declared right of the opening fence), will automatically highlight the code content as HTML e.g. ` ```html `:
+Fenced code blocks (code enclosed between triple backticks above and below) that specify a code language (declared right of the opening fence), will automatically highlight the code content as HTML e.g. ` ```html `:
 
 ````md
 ```html

content/docs/quickstart.md

@@ -231,7 +231,7 @@ hugo new docs/examplepage.md
 
 ## Preview your Site
 
-Now that you've created some sample content you can preview your new Lotus Docs site using the `huge server` command:
+Now that you've created some sample content you can preview your new Lotus Docs site using the `hugo server` command:
 
 ```shell
 hugo server -D
@@ -309,4 +309,4 @@ content/
 
 This is reflected in the sidebar menu with `parent-directory` functioning as a dropdown menu containing a link to the **Doc Three** post:
 
-![sidebar parent menu example](https://res.cloudinary.com/lotuslabs/image/upload/v1684802032/Lotus%20Docs/images/sidebar_menu_example_02_jsecye.webp)
+![sidebar parent menu example](https://res.cloudinary.com/lotuslabs/image/upload/v1684802032/Lotus%20Docs/images/sidebar_menu_example_02_jsecye.webp)

content/docs/reference/configuration.md

@@ -47,6 +47,7 @@ Social links are displayed as icons in the top left corner of the Lotus Docs the
 | Parameter | Type | Default Value | Description |
 |---------|-----|-----|------|
 | `github` | string | N/A | Enables the GitHub social icon link using the GitHub URL value set here e.g. `colinwilson` or `colinwilson/lotusdocs` |
+| `bluesky` | string | N/A | Enables the Bluesky social icon link using the username value set here e.g. `lotusdocs.bsky.social` |
 | `twitter` | string | N/A | Enables the Twitter / X social icon link using the username value set here e.g. `lotusdocs` |
 | `instagram` | string | N/A | Enables the Instagram social icon link using the username value set here e.g. `lotusdocs` |
 | `rss` | boolean | `false` | Display an RSS icon link? |