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/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/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/content/docs/feature-guide/_index.md b/content/docs/feature-guide/_index.md index cb3a722..fa15278 100644 --- a/content/docs/feature-guide/_index.md +++ b/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 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/content/docs/getting-started.md b/content/docs/getting-started.md index 5db1f13..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 = [""] @@ -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/content/docs/overview.md b/content/docs/overview.md index 3223cc2..3e40cf6 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. @@ -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/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/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/content/docs/test_markdown/unorthodox.md b/content/docs/test_markdown/unorthodox.md index 232637e..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. @@ -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 87b083d..b2504b9 100644 --- a/docsearch-preview.json +++ b/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" } } \ No newline at end of file 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 diff --git a/themes/lotusdocs b/themes/lotusdocs index 1d7055f..e9e8ee9 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 1d7055f471f06b17418ea3e0a4fb6c55fb3132d2 +Subproject commit e9e8ee9661cabf26b1528eea4ccdc4cfbd11cc64