From 701e9e60d3c0b2f3d0a56a8d78a6cfdedab87392 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 01:27:34 +0000 Subject: [PATCH 01/23] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- themes/lotusdocs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/lotusdocs b/themes/lotusdocs index 1d7055f..98c0dce 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 1d7055f471f06b17418ea3e0a4fb6c55fb3132d2 +Subproject commit 98c0dce61b51e7b282183052da9a7004e8c8d666 From 6e4cb915421a0d62a82fd945870657095649a2bb Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 01:47:59 +0000 Subject: [PATCH 02/23] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- themes/lotusdocs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/lotusdocs b/themes/lotusdocs index 98c0dce..5ab9191 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 98c0dce61b51e7b282183052da9a7004e8c8d666 +Subproject commit 5ab9191c801e5ffcf11e2f48bbcb942a692114df From 2191b9fba4449927c1c17e191c445fdfa65b0d13 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 13:29:22 +0000 Subject: [PATCH 03/23] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- themes/lotusdocs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/lotusdocs b/themes/lotusdocs index 5ab9191..4e9df14 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 5ab9191c801e5ffcf11e2f48bbcb942a692114df +Subproject commit 4e9df14d4a3dd5a65c915564df8ba1a715728fd5 From e90ab71bded4aa046bdd3ab89fe38d0b5fbc2dd4 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 15:20:17 +0000 Subject: [PATCH 04/23] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- themes/lotusdocs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/lotusdocs b/themes/lotusdocs index 4e9df14..46c20d7 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 4e9df14d4a3dd5a65c915564df8ba1a715728fd5 +Subproject commit 46c20d73dad428397ba58a3477cd8268c791dbef From 8f13adf74b9e1667c51e200b517055040cc25e63 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 15:48:34 +0000 Subject: [PATCH 05/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update=20=F0=9F=8E=A8=20theme=20up?= =?UTF-8?q?date?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/shortcodes/alerts.md | 2 +- docsearch-preview.json | 2 +- themes/lotusdocs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index 5959a7c..0378dfb 100644 --- a/content/docs/feature-guide/shortcodes/alerts.md +++ b/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 {{}} diff --git a/docsearch-preview.json b/docsearch-preview.json index 87b083d..f429fca 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -19,7 +19,7 @@ "#breadcrumbs" ], "selectors": { - "lvl0": ".docs-content .content-title", + "lvl0": ".docs-content .content-title .title-text", "lvl1": ".docs-content .lead", "lvl2": "#content h2", "lvl3": "#content h3", diff --git a/themes/lotusdocs b/themes/lotusdocs index 46c20d7..edeccb5 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 46c20d73dad428397ba58a3477cd8268c791dbef +Subproject commit edeccb5648dfd5d66481d699967c97052ef76590 From c37d8ea62e95c1c6a6b086233fa6655568ada5c9 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 16:33:50 +0000 Subject: [PATCH 06/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index 3223cc2..a09ea56 100644 --- a/content/docs/overview.md +++ b/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. diff --git a/docsearch-preview.json b/docsearch-preview.json index f429fca..a19ecbf 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -19,7 +19,10 @@ "#breadcrumbs" ], "selectors": { - "lvl0": ".docs-content .content-title .title-text", + "lvl0": { + "selector": ".docs-content .content-title .title-text", + "global": true + }, "lvl1": ".docs-content .lead", "lvl2": "#content h2", "lvl3": "#content h3", From 11218b4422f6d80afbceec7f4a04ad85c6a719ec Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 16:57:56 +0000 Subject: [PATCH 07/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index a09ea56..3e40cf6 100644 --- a/content/docs/overview.md +++ b/content/docs/overview.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docsearch-preview.json b/docsearch-preview.json index a19ecbf..e91eb89 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -20,14 +20,17 @@ ], "selectors": { "lvl0": { + "selector": ".breadcrumb .active", + "global": true + }, + "lvl1": { "selector": ".docs-content .content-title .title-text", "global": true }, - "lvl1": ".docs-content .lead", "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" } } \ No newline at end of file From 57cfce7d876e111c4f72fe1ca1ef12c38e2031c3 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 17:06:51 +0000 Subject: [PATCH 08/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/contributing/how-to-contribute.md | 4 ++-- docsearch-preview.json | 7 ++----- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/content/docs/contributing/how-to-contribute.md b/content/docs/contributing/how-to-contribute.md index 76a478b..5bfdfc2 100644 --- a/content/docs/contributing/how-to-contribute.md +++ b/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 diff --git a/docsearch-preview.json b/docsearch-preview.json index e91eb89..50f527e 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -20,17 +20,14 @@ ], "selectors": { "lvl0": { - "selector": ".breadcrumb .active", - "global": true - }, - "lvl1": { "selector": ".docs-content .content-title .title-text", "global": true }, + "lvl1": "#content h1", "lvl2": "#content h2", "lvl3": "#content h3", "lvl4": "#content h4", "lvl5": "#content h5", - "text": ".docs-content .lead, #content p,#content ul,#content ol,#content .alert,#content blockquote" + "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file From 0cd0adb605462f0441ff78f5370f6bd682c1515e Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 17:15:27 +0000 Subject: [PATCH 09/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/test_markdown/doks-readme.md | 172 ---------------------- docsearch-preview.json | 5 +- 2 files changed, 4 insertions(+), 173 deletions(-) delete mode 100644 content/docs/test_markdown/doks-readme.md diff --git a/content/docs/test_markdown/doks-readme.md b/content/docs/test_markdown/doks-readme.md deleted file mode 100644 index 6fccc5d..0000000 --- a/content/docs/test_markdown/doks-readme.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: "DOKS Readme" -# icon: -description: "DOKS Documentation theme readme." -lead: "An example markdown page for testing purposes." -date: 2022-10-23T3:51:15+00:00 -lastmod: 2022-10-23T3:51:15+00:00 -draft: true -images: [] -weight: 10050 -toc: true ---- - -

- - Doks - -

- -

- Doks -

- -

- Modern Documentation Theme -

- -

- Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize. -

- -

- - GitHub - - - GitHub release (latest SemVer including pre-releases) - - - npm (scoped) - - - GitHub Workflow Status (branch) - - - Netlify - -

- -![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/doks.png) - -## Demo - -- [doks.netlify.app](https://doks.netlify.app/) - -## Why Doks? - -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=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. - -4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually. - -5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files. - -6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers. - -7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking. - -8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs. - -9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. - -### Other features - -- __Multilingual and i18n__ support -- __Versioning__ documentation support -- __KaTeX__ math typesetting -- __Mermaid__ diagrams and visualization -- __highlight.js__ syntax highlighting - -## Requirements - -- [Git](https://git-scm.com/) — latest source release -- [Node.js](https://nodejs.org/) — latest LTS version or newer - -
-Why Node.js? - -Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts. - -
- -## Get started - -Start a new Doks project in three steps: - -### 1. Create a new site - -Doks is available as a child theme and a starter theme. - -#### Child theme - -- Intended for novice to intermediate users -- Intended for minor customizations -- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) - -```bash -git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site -``` - -#### Starter theme - -- Intended for intermediate to advanced users -- Intended for major customizations -- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) - -```bash -git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site -``` - -
-Help me choose - -Not sure which one is for you? Pick the child theme. - -
- -### 2. Install dependencies - -```bash -npm install -``` - -### 3. Start development server - -```bash -npm run start -``` - -## Other commands - -Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks. - -## Documentation - -- [Netlify](https://docs.netlify.com/) -- [Hugo](https://gohugo.io/documentation/) -- [Doks](https://getdoks.org/) - -## Communities - -- [Netlify Community](https://community.netlify.com/) -- [Hugo Forums](https://discourse.gohugo.io/) -- [Doks Discussions](https://github.com/h-enk/doks/discussions) - -## Sponsors - -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. - -[![OC sponsor 0](https://opencollective.com/doks/tiers/sponsor/0/avatar.svg)](https://opencollective.com/doks/tiers/sponsor/0/website) -[![OC sponsor 1](https://opencollective.com/doks/tiers/sponsor/1/avatar.svg)](https://opencollective.com/doks/tiers/sponsor/1/website) - -## Backers - -Support this project by becoming a backer. Your avatar will show up here. - -[![Backers](https://opencollective.com/doks/tiers/backer.svg?49741992)](https://opencollective.com/doks) diff --git a/docsearch-preview.json b/docsearch-preview.json index 50f527e..bb62884 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -23,7 +23,10 @@ "selector": ".docs-content .content-title .title-text", "global": true }, - "lvl1": "#content h1", + "lvl1": { + "selector": ".docs-content .content-title .title-text", + "global": true + }, "lvl2": "#content h2", "lvl3": "#content h3", "lvl4": "#content h4", From 71a9dc44373663efbc29821cf2069b37d81d3fa6 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 17:23:59 +0000 Subject: [PATCH 10/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 13 +++++-------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index 3e40cf6..b4a0ad7 100644 --- a/content/docs/overview.md +++ b/content/docs/overview.md @@ -9,7 +9,7 @@ toc = true # featured_image = "" description = "Lotus Docs is a modern documentation theme built for Hugo." publishdate = "2022-09-30T05:33:22+01:00" -tags = ["Beginners"] +tags = ["Beginners","Introduction"] categories = [""] [twitter] diff --git a/docsearch-preview.json b/docsearch-preview.json index bb62884..533d104 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -23,14 +23,11 @@ "selector": ".docs-content .content-title .title-text", "global": true }, - "lvl1": { - "selector": ".docs-content .content-title .title-text", - "global": true - }, - "lvl2": "#content h2", - "lvl3": "#content h3", - "lvl4": "#content h4", - "lvl5": "#content h5", + "lvl1": "#content h2", + "lvl2": "#content h3", + "lvl3": "#content h4", + "lvl4": "#content h5", + "lvl5": "#content h6", "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file From 29bca7c1ba2e0e9d813bc386966d01c2955712aa Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 17:58:43 +0000 Subject: [PATCH 11/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/test_markdown/unorthodox.md | 2 +- docsearch-preview.json | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/content/docs/test_markdown/unorthodox.md b/content/docs/test_markdown/unorthodox.md index 232637e..78e656c 100644 --- a/content/docs/test_markdown/unorthodox.md +++ b/content/docs/test_markdown/unorthodox.md @@ -41,7 +41,7 @@ The default context 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 context 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 >}} diff --git a/docsearch-preview.json b/docsearch-preview.json index 533d104..1bac519 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -27,7 +27,6 @@ "lvl2": "#content h3", "lvl3": "#content h4", "lvl4": "#content h5", - "lvl5": "#content h6", "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file From 4ced403409a693db046819c2f1a9e7343c41ed15 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 18:22:10 +0000 Subject: [PATCH 12/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/contributing/_index.md | 2 +- docsearch-preview.json | 14 ++++++++++---- themes/lotusdocs | 2 +- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/content/docs/contributing/_index.md b/content/docs/contributing/_index.md index 6bc78c6..f7520cf 100644 --- a/content/docs/contributing/_index.md +++ b/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 diff --git a/docsearch-preview.json b/docsearch-preview.json index 1bac519..7e668a0 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -20,13 +20,19 @@ ], "selectors": { "lvl0": { + "selector": "//li[@class=\"breadcrumb-item text-capitalize active\"]/../a", + "type": "xpath", + "global": true, + "default_value": "Documentation" + }, + "lvl1": { "selector": ".docs-content .content-title .title-text", "global": true }, - "lvl1": "#content h2", - "lvl2": "#content h3", - "lvl3": "#content h4", - "lvl4": "#content h5", + "lvl2": "#content h2", + "lvl3": "#content h3", + "lvl4": "#content h4", + "lvl5": "#content h5", "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file diff --git a/themes/lotusdocs b/themes/lotusdocs index edeccb5..3bd5623 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit edeccb5648dfd5d66481d699967c97052ef76590 +Subproject commit 3bd562394e178c5c2c83273d7d4ae2c9c82713fa From 5cdcd53f3a42b5bb2ebb784b7827437ec31ea0fb Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 18:37:16 +0000 Subject: [PATCH 13/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/_index.md | 2 +- docsearch-preview.json | 19 +++++-------------- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/content/docs/feature-guide/_index.md b/content/docs/feature-guide/_index.md index cb3a722..95ccf6e 100644 --- a/content/docs/feature-guide/_index.md +++ b/content/docs/feature-guide/_index.md @@ -1,7 +1,7 @@ --- 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 diff --git a/docsearch-preview.json b/docsearch-preview.json index 7e668a0..b589746 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -19,20 +19,11 @@ "#breadcrumbs" ], "selectors": { - "lvl0": { - "selector": "//li[@class=\"breadcrumb-item text-capitalize active\"]/../a", - "type": "xpath", - "global": true, - "default_value": "Documentation" - }, - "lvl1": { - "selector": ".docs-content .content-title .title-text", - "global": true - }, - "lvl2": "#content h2", - "lvl3": "#content h3", - "lvl4": "#content h4", - "lvl5": "#content h5", + "lvl0": ".docs-content .content-title .title-text", + "lvl1": "#content h2", + "lvl2": "#content h3", + "lvl3": "#content h4", + "lvl4": "#content h5", "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file From ba260ccc84c64c9c66f6e06b45e066b0faee7c90 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 18:38:15 +0000 Subject: [PATCH 14/23] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- themes/lotusdocs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/lotusdocs b/themes/lotusdocs index 3bd5623..5850d2a 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 3bd562394e178c5c2c83273d7d4ae2c9c82713fa +Subproject commit 5850d2aa8e8eafb92a6062b515130cf58844213f From 80a3a3b739d11d45247d2e4af05ccfa741d79d8a Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 18:48:10 +0000 Subject: [PATCH 15/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/test_markdown/_index.md | 2 +- docsearch-preview.json | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/test_markdown/_index.md b/content/docs/test_markdown/_index.md index 8b1734c..a2f4d8c 100644 --- a/content/docs/test_markdown/_index.md +++ b/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 diff --git a/docsearch-preview.json b/docsearch-preview.json index b589746..ef480e6 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -19,11 +19,11 @@ "#breadcrumbs" ], "selectors": { - "lvl0": ".docs-content .content-title .title-text", - "lvl1": "#content h2", - "lvl2": "#content h3", - "lvl3": "#content h4", - "lvl4": "#content h5", + "lvl1": ".docs-content .content-title .title-text", + "lvl2": "#content h2", + "lvl3": "#content h3", + "lvl4": "#content h4", + "lvl5": "#content h5", "text": ".docs-content .lead,#content p,#content ul,#content ol,#content .alert,#content blockquote" } } \ No newline at end of file From c54927df7fca5b14392a13e1f1ffb20d3089415c Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 18:57:21 +0000 Subject: [PATCH 16/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/_index.md | 1 - docsearch-preview.json | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/content/docs/feature-guide/_index.md b/content/docs/feature-guide/_index.md index 95ccf6e..fa15278 100644 --- a/content/docs/feature-guide/_index.md +++ b/content/docs/feature-guide/_index.md @@ -3,7 +3,6 @@ weight: 210 title: "Feature Guide" 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 diff --git a/docsearch-preview.json b/docsearch-preview.json index ef480e6..2aa21b3 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -19,6 +19,10 @@ "#breadcrumbs" ], "selectors": { + "lvl0": { + "selector": "", + "default_value": "Documentation" + }, "lvl1": ".docs-content .content-title .title-text", "lvl2": "#content h2", "lvl3": "#content h3", From 12f8ac89cecf6033b5469cce6499cbd619904c0b Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 19:20:50 +0000 Subject: [PATCH 17/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/getting-started.md | 2 +- docsearch-preview.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index 5db1f13..893351c 100644 --- a/content/docs/getting-started.md +++ b/content/docs/getting-started.md @@ -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 = "" +++ diff --git a/docsearch-preview.json b/docsearch-preview.json index 2aa21b3..cec696b 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -20,7 +20,7 @@ ], "selectors": { "lvl0": { - "selector": "", + "selector": "#breadcrumbs .breadcrumb-item:nth-last-child(2) a", "default_value": "Documentation" }, "lvl1": ".docs-content .content-title .title-text", From 4bb4b17857252ed8397c0dd58caba3dcc0084974 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 19:35:49 +0000 Subject: [PATCH 18/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/getting-started.md | 2 +- docsearch-preview.json | 2 +- themes/lotusdocs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index 893351c..fddeab1 100644 --- a/content/docs/getting-started.md +++ b/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 = [""] diff --git a/docsearch-preview.json b/docsearch-preview.json index cec696b..c3cc9ea 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -20,7 +20,7 @@ ], "selectors": { "lvl0": { - "selector": "#breadcrumbs .breadcrumb-item:nth-last-child(2) a", + "selector": "#breadcrumbs a:nth-last-child(2)", "default_value": "Documentation" }, "lvl1": ".docs-content .content-title .title-text", diff --git a/themes/lotusdocs b/themes/lotusdocs index 5850d2a..bae68b9 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 5850d2aa8e8eafb92a6062b515130cf58844213f +Subproject commit bae68b9e4dfd2ac3a34014b4866fe7b862ba8d32 From e371f133dbf235a2cb8d88b014eb4d556a555320 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 19:40:54 +0000 Subject: [PATCH 19/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index b4a0ad7..3e40cf6 100644 --- a/content/docs/overview.md +++ b/content/docs/overview.md @@ -9,7 +9,7 @@ toc = true # featured_image = "" description = "Lotus Docs is a modern documentation theme built for Hugo." publishdate = "2022-09-30T05:33:22+01:00" -tags = ["Beginners","Introduction"] +tags = ["Beginners"] categories = [""] [twitter] diff --git a/docsearch-preview.json b/docsearch-preview.json index c3cc9ea..36e7379 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -15,8 +15,7 @@ "i", ".material-icons", "#sidebar", - "#toc", - "#breadcrumbs" + "#toc" ], "selectors": { "lvl0": { From 2a7cfad933f3aa1b44c20d0e75f62a641fe4b1db Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 19:49:23 +0000 Subject: [PATCH 20/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index 3e40cf6..b4a0ad7 100644 --- a/content/docs/overview.md +++ b/content/docs/overview.md @@ -9,7 +9,7 @@ toc = true # featured_image = "" description = "Lotus Docs is a modern documentation theme built for Hugo." publishdate = "2022-09-30T05:33:22+01:00" -tags = ["Beginners"] +tags = ["Beginners","Introduction"] categories = [""] [twitter] diff --git a/docsearch-preview.json b/docsearch-preview.json index 36e7379..4b03d42 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -15,11 +15,12 @@ "i", ".material-icons", "#sidebar", - "#toc" + "#toc", + "#breadcrumbs" ], "selectors": { "lvl0": { - "selector": "#breadcrumbs a:nth-last-child(2)", + "selector": ".breadcrumb a:nth-last-child(2)", "default_value": "Documentation" }, "lvl1": ".docs-content .content-title .title-text", From 89b026f626660de6750bdfb168e16943b67d86b4 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 19:53:50 +0000 Subject: [PATCH 21/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/overview.md | 2 +- docsearch-preview.json | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/content/docs/overview.md b/content/docs/overview.md index b4a0ad7..3e40cf6 100644 --- a/content/docs/overview.md +++ b/content/docs/overview.md @@ -9,7 +9,7 @@ toc = true # featured_image = "" description = "Lotus Docs is a modern documentation theme built for Hugo." publishdate = "2022-09-30T05:33:22+01:00" -tags = ["Beginners","Introduction"] +tags = ["Beginners"] categories = [""] [twitter] diff --git a/docsearch-preview.json b/docsearch-preview.json index 4b03d42..1422b0c 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -15,8 +15,7 @@ "i", ".material-icons", "#sidebar", - "#toc", - "#breadcrumbs" + "#toc" ], "selectors": { "lvl0": { From af5b097848f7624c4919a26e8e47df30b78044bf Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 20:05:04 +0000 Subject: [PATCH 22/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/test_markdown/unorthodox.md | 2 +- docsearch-preview.json | 3 ++- themes/lotusdocs | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/docs/test_markdown/unorthodox.md b/content/docs/test_markdown/unorthodox.md index 78e656c..4352de5 100644 --- a/content/docs/test_markdown/unorthodox.md +++ b/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.
No `context` or `icon` parameter defined. diff --git a/docsearch-preview.json b/docsearch-preview.json index 1422b0c..b2504b9 100644 --- a/docsearch-preview.json +++ b/docsearch-preview.json @@ -15,7 +15,8 @@ "i", ".material-icons", "#sidebar", - "#toc" + "#toc", + "#back-to-top" ], "selectors": { "lvl0": { diff --git a/themes/lotusdocs b/themes/lotusdocs index bae68b9..e9e8ee9 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit bae68b9e4dfd2ac3a34014b4866fe7b862ba8d32 +Subproject commit e9e8ee9661cabf26b1528eea4ccdc4cfbd11cc64 From f188081543bc58d0de9aa26c40b0c728444e0cf7 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Wed, 23 Nov 2022 21:00:36 +0000 Subject: [PATCH 23/23] =?UTF-8?q?=F0=9F=94=8D=20update=20DocSearch=20confi?= =?UTF-8?q?g=20=E2=9A=99=EF=B8=8F=20update=20workflows?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/deploy-preview.yaml | 6 ++++-- .github/workflows/deploy-production.yaml | 6 ++++-- docsearch-prod.json | 11 +++++++---- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.github/workflows/deploy-preview.yaml b/.github/workflows/deploy-preview.yaml index e573da2..5e639a3 100644 --- a/.github/workflows/deploy-preview.yaml +++ b/.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 diff --git a/.github/workflows/deploy-production.yaml b/.github/workflows/deploy-production.yaml index b06a57e..b4b0664 100644 --- a/.github/workflows/deploy-production.yaml +++ b/.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 diff --git a/docsearch-prod.json b/docsearch-prod.json index b5878a0..fc207b4 100644 --- a/docsearch-prod.json +++ b/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" } } \ No newline at end of file