From 0bffe177a1e10b9e1f9b334f566717b708c14d03 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Mon, 21 Nov 2022 18:10:42 +0000 Subject: [PATCH 1/8] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update=20=E2=9A=99?= =?UTF-8?q?=EF=B8=8F=20config=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- config.toml | 10 ++++++---- themes/lotusdocs | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/config.toml b/config.toml index 48c9b17..679c804 100644 --- a/config.toml +++ b/config.toml @@ -25,12 +25,12 @@ enableGitInfo = true # N.B. .GitInfo does not currently function with submodule [params] # google_fonts = [ - # ["Nunito Sans", "300, 400, 600, 700"], + # ["Comic Neue", "300, 400, 600, 700"], # ["Source Code Pro", "500, 700"] # ] - # sans_serif_font = "Nunito Sans" # Default is System font - # secondary_font = "Nunito Sans" # Default is System font + # sans_serif_font = "Comic Neue" # Default is System font + # secondary_font = "Comic Neue" # Default is System font # mono_font = "Source Code Pro" # Default is System font [params.footer] @@ -46,6 +46,8 @@ enableGitInfo = true # N.B. .GitInfo does not currently function with submodule [params.docs] # Parameters for the /docs 'template' title = "Lotus Labs Documentation" # default html title for documentation pages/sections + darkMode = true # enable dark mode option? default false + ghrepo = "github.com/colinwilson/lotusdocs.vercel.app" # Git repository URL for your site editPage = true # enable 'Edit this page' feature - default false lastMod = true # enable 'Last modified' date on pages - default false @@ -67,7 +69,7 @@ enableGitInfo = true # N.B. .GitInfo does not currently function with submodule [params.docsearch] # Parameters for DocSearch appID = "O2QIOCBDAK" # Algolia Application ID - apiKey = "fdc60eee76a72a35d739b54521498b77" # Algolia Search-Only API Key + apiKey = "fdc60eee76a72a35d739b54521498b77" # Algolia Search-Only API (Public) Key indexName = "prod_lotusdocs.dev" # Index Name to perform search on (or set env variable HUGO_PARAM_DOCSEARCH_indexName) [menu] diff --git a/themes/lotusdocs b/themes/lotusdocs index 000f1cb..0856356 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 000f1cb4fb5161f0bd1d5b43d4a0e4303008830c +Subproject commit 08563568db07055aa801047703e19580c336003a From b1d85568123d7299e21d7ed6480b708700ca001b Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 13:13:00 +0000 Subject: [PATCH 2/8] =?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 0856356..4b2a549 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 08563568db07055aa801047703e19580c336003a +Subproject commit 4b2a549b7004324efd3f3ac5ae7180363ec1df28 From aa8c30486641c0d52fb1cf3aa7e1d4b41b9814e5 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 14:36:16 +0000 Subject: [PATCH 3/8] =?UTF-8?q?=F0=9F=93=81=20content=20update=20?= =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/_index.md | 11 +++++++++++ content/docs/feature-guide/shortcodes/_index.md | 11 +++++++++++ content/docs/feature-guide/shortcodes/alerts.md | 16 ++++++++++++++++ content/docs/feature-guide/shortcodes/tables.md | 12 ++++++++++++ themes/lotusdocs | 2 +- 5 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 content/docs/feature-guide/_index.md create mode 100644 content/docs/feature-guide/shortcodes/_index.md create mode 100644 content/docs/feature-guide/shortcodes/alerts.md create mode 100644 content/docs/feature-guide/shortcodes/tables.md diff --git a/content/docs/feature-guide/_index.md b/content/docs/feature-guide/_index.md new file mode 100644 index 0000000..cb3a722 --- /dev/null +++ b/content/docs/feature-guide/_index.md @@ -0,0 +1,11 @@ +--- +weight: 210 +title: "Feature Guide" +description: "A Guide to Using Lotus Docs' Features." +icon: celebration +lead: "" +date: 2022-11-22T12:36:15+00:00 +lastmod: 2022-11-22T12:36:15+00:00 +draft: true +images: [] +--- \ No newline at end of file diff --git a/content/docs/feature-guide/shortcodes/_index.md b/content/docs/feature-guide/shortcodes/_index.md new file mode 100644 index 0000000..5f3f820 --- /dev/null +++ b/content/docs/feature-guide/shortcodes/_index.md @@ -0,0 +1,11 @@ +--- +weight: 220 +title: "Shortcodes" +description: "Lotus Docs Custom Shortcodes." +icon: code +lead: "" +date: 2022-11-22T12:40:15+00:00 +lastmod: 2022-11-22T12:40:15+00:00 +draft: true +images: [] +--- \ No newline at end of file diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md new file mode 100644 index 0000000..9e4e41d --- /dev/null +++ b/content/docs/feature-guide/shortcodes/alerts.md @@ -0,0 +1,16 @@ +--- +weight: 220 +title: "Alerts" +icon: warning +description: "Alert Shortcodes." +lead: "Alerts." +date: 2022-11-22T12:42:31+00:00 +lastmod: 2022-11-22T12:42:31+00:00 +draft: true +images: [] +toc: true +--- + +## Adding a Page Alert + +A page alert can be added using the following code: \ No newline at end of file diff --git a/content/docs/feature-guide/shortcodes/tables.md b/content/docs/feature-guide/shortcodes/tables.md new file mode 100644 index 0000000..db2d5d0 --- /dev/null +++ b/content/docs/feature-guide/shortcodes/tables.md @@ -0,0 +1,12 @@ +--- +weight: 240 +title: "Tables" +icon: table_chart +description: "Table Shortcodes." +lead: "Tables." +date: 2022-11-22T12:45:31+00:00 +lastmod: 2022-11-22T12:45:31+00:00 +draft: true +images: [] +toc: true +--- \ No newline at end of file diff --git a/themes/lotusdocs b/themes/lotusdocs index 4b2a549..4d99f27 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 4b2a549b7004324efd3f3ac5ae7180363ec1df28 +Subproject commit 4d99f2797809b430ab6d00bd27b9feaf1fcbacf8 From e435fca56f764c67203d5ef3754a1e8a7dc486e3 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 19:47:43 +0000 Subject: [PATCH 4/8] =?UTF-8?q?=F0=9F=93=81=20content=20update=20?= =?UTF-8?q?=F0=9F=8E=A8=20theme=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../docs/feature-guide/shortcodes/alerts.md | 96 ++++++++++++++++++- content/docs/test_markdown/unorthodox.md | 2 +- themes/lotusdocs | 2 +- 3 files changed, 93 insertions(+), 7 deletions(-) diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index 9e4e41d..b374dff 100644 --- a/content/docs/feature-guide/shortcodes/alerts.md +++ b/content/docs/feature-guide/shortcodes/alerts.md @@ -1,11 +1,11 @@ --- weight: 220 title: "Alerts" -icon: warning -description: "Alert Shortcodes." +icon: notification_important +description: "How to use Alert Shortcodes." lead: "Alerts." -date: 2022-11-22T12:42:31+00:00 -lastmod: 2022-11-22T12:42:31+00:00 +date: 2022-11-22T13:42:31+00:00 +lastmod: 2022-11-22T13:42:31+00:00 draft: true images: [] toc: true @@ -13,4 +13,90 @@ toc: true ## Adding a Page Alert -A page alert can be added using the following code: \ No newline at end of file +A page alert can be added to your markdown using the following code: + +```md +{{}} +``` + +The above code results in the following alert: + +{{< alert text="This is the default alert. It consists of a default theme colour and icon." />}} + +## Alert with Context + +Add context to an alert via the `context` parameter: + +```md +{{info context. It consists of the info theme colour and icon." /*/>}} +``` + +Here's what is rendered: + +{{< alert context="info" text="This is an alert with an info context. It consists of the info theme colour and icon." />}} + +The additional available alert contexts include `success`, `danger`, `warning`, `primary`, `light` and `dark`: + +{{< alert context="success" text="This is an alert with a success context. It consists of the success theme colour and icon." />}} + +{{< alert context="danger" text="This is an alert with a danger context. It consists of the danger theme colour and icon." />}} + +{{< alert context="warning" text="This is an alert with a warning context. It consists of the warning theme colour and icon." />}} + +{{< alert context="primary" text="This is an alert with a primary context. Its theme and icon color are that of the current primary theme colour." />}} + +{{< alert context="light" text="This is an alert with a light context. It consists of the light theme colour. The light alert has no default icon." />}} + +{{< alert context="dark" text="This is an alert with a dark context. It consists of the dark theme colour. The dark alert has no default icon." />}} + +## Alert with Custom Emoji Icon + +The default icon of an alert can be substituted with an emoji using the `icon` parameter: + +```md +{{info context alert with a tomato emoji replacing the default icon. It consists of the info theme colour and icon." /*/>}} +``` + +{{< alert icon="🍅" context="info" text="This is an info context alert with a tomato emoji replacing the default icon. It consists of the info theme colour and icon." />}} + +## Alert with No Icon + +An alert can be rendered without an icon by setting the `icon` parameter to an empty space, `icon=" "`: + +{{< alert context="warning" >}} +**N.B.** The icon parameter **must** contain a space. Setting it to `icon=""` will render the default icon. +{{< /alert >}} + +```md +{{info context alert has no icon." /*/>}} +``` + +{{< alert icon=" " context="info" text="This info context alert has no icon." />}} + +## Render Markdown & HTML inside an Alert + +Using a [paired shortcode](https://gohugo.io/content-management/shortcodes/) allows Markdown and HTML to be rendered inside an alert: + +``` +{{}} +This alert can contain **markdown** such as a list: + +My Shopping List: +1. Tomatoes +2. Bananas +3. Pineapples + +or HTML e.g. A bold, italic sentence +{{< /alert /*/>}} +``` + +{{< alert icon="🍏" context="success" >}} +This alert can contain **markdown** such as a list: + +My Shopping List: +1. Tomatoes +2. Bananas +3. Pineapples + +or HTML e.g. A bold, italic sentence +{{< /alert >}} \ No newline at end of file diff --git a/content/docs/test_markdown/unorthodox.md b/content/docs/test_markdown/unorthodox.md index 3577d19..232637e 100644 --- a/content/docs/test_markdown/unorthodox.md +++ b/content/docs/test_markdown/unorthodox.md @@ -52,7 +52,7 @@ This next sentence [demonstrates](https://colinwilson.uk) the colour of a link i {{< alert context="danger" text="The Tutorial is intended for novice to intermediate users.
Hello World" />}} -{{< alert context="secondary" >}} +{{< alert context="light" >}} The Tutorial is intended for novice to intermediate users.
Hello World This next sentence [demonstrates](https://colinwilson.uk) the colour of a link inside an alert box. {{< /alert >}} diff --git a/themes/lotusdocs b/themes/lotusdocs index 4d99f27..5e2aeda 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 4d99f2797809b430ab6d00bd27b9feaf1fcbacf8 +Subproject commit 5e2aeda76f525e2ac8bf0d9309d073eb265c27d9 From f32f36dca3c6b9a78a0bf485db5958d4d64dd193 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 20:01:52 +0000 Subject: [PATCH 5/8] =?UTF-8?q?=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/shortcodes/alerts.md | 4 ++-- content/docs/overview.md | 2 +- themes/lotusdocs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index b374dff..9c7b184 100644 --- a/content/docs/feature-guide/shortcodes/alerts.md +++ b/content/docs/feature-guide/shortcodes/alerts.md @@ -78,7 +78,7 @@ An alert can be rendered without an icon by setting the `icon` parameter to an e Using a [paired shortcode](https://gohugo.io/content-management/shortcodes/) allows Markdown and HTML to be rendered inside an alert: ``` -{{}} +{{}} This alert can contain **markdown** such as a list: My Shopping List: @@ -90,7 +90,7 @@ or HTML e.g. A bold, italic sentence {{< /alert /*/>}} ``` -{{< alert icon="🍏" context="success" >}} +{{< alert icon="🛒" context="success" >}} This alert can contain **markdown** such as a list: My Shopping List: diff --git a/content/docs/overview.md b/content/docs/overview.md index 2339365..3223cc2 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** ready 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 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. {{< /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/themes/lotusdocs b/themes/lotusdocs index 5e2aeda..05da801 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 5e2aeda76f525e2ac8bf0d9309d073eb265c27d9 +Subproject commit 05da8018e087ccbd628fa17293245408daee9b66 From f99afd5238ecacf4c62ad3d21c63abdf1ff8eba4 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 20:14:38 +0000 Subject: [PATCH 6/8] =?UTF-8?q?=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/shortcodes/alerts.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index 9c7b184..6b7654e 100644 --- a/content/docs/feature-guide/shortcodes/alerts.md +++ b/content/docs/feature-guide/shortcodes/alerts.md @@ -77,26 +77,26 @@ An alert can be rendered without an icon by setting the `icon` parameter to an e Using a [paired shortcode](https://gohugo.io/content-management/shortcodes/) allows Markdown and HTML to be rendered inside an alert: -``` +```md {{}} -This alert can contain **markdown** such as a list: +This alert contains a **markdown** list and header: -My Shopping List: +#### My Shopping List: 1. Tomatoes 2. Bananas 3. Pineapples -or HTML e.g. A bold, italic sentence +and a sentence styled using HTML tags such as \ and \ {{< /alert /*/>}} ``` {{< alert icon="🛒" context="success" >}} -This alert can contain **markdown** such as a list: +This alert contains a **markdown** list and header: -My Shopping List: +#### My Shopping List: 1. Tomatoes 2. Bananas 3. Pineapples -or HTML e.g. A bold, italic sentence +and a sentence styled using HTML tags such as \ and \ {{< /alert >}} \ No newline at end of file From 363624874229eb18d80feda34cf4b62051e1d094 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 20:42:51 +0000 Subject: [PATCH 7/8] =?UTF-8?q?=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/shortcodes/alerts.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index 6b7654e..81c885c 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 code: +A page alert can be added to your markdown using the following Hugo shortcode: ```md {{}} @@ -35,7 +35,7 @@ Here's what is rendered: {{< alert context="info" text="This is an alert with an info context. It consists of the info theme colour and icon." />}} -The additional available alert contexts include `success`, `danger`, `warning`, `primary`, `light` and `dark`: +Additional alert contexts include `success`, `danger`, `warning`, `primary`, `light` and `dark`: {{< alert context="success" text="This is an alert with a success context. It consists of the success theme colour and icon." />}} @@ -51,17 +51,17 @@ The additional available alert contexts include `success`, `danger`, `warning`, ## Alert with Custom Emoji Icon -The default icon of an alert can be substituted with an emoji using the `icon` parameter: +The default icon for an alert context can be substituted with an emoji using the `icon` parameter: ```md -{{info context alert with a tomato emoji replacing the default icon. It consists of the info theme colour and icon." /*/>}} +{{info context alert with a tomato emoji replacing the default icon. The info theme colour remains unchanged." /*/>}} ``` -{{< alert icon="🍅" context="info" text="This is an info context alert with a tomato emoji replacing the default icon. It consists of the info theme colour and icon." />}} +{{< alert icon="🍅" context="info" text="This is an info context alert with a tomato emoji replacing the default icon. The info theme colour remains unchanged." />}} ## Alert with No Icon -An alert can be rendered without an icon by setting the `icon` parameter to an empty space, `icon=" "`: +An alert can be rendered without its default icon by setting the `icon` parameter to an empty space, `icon=" "`: {{< alert context="warning" >}} **N.B.** The icon parameter **must** contain a space. Setting it to `icon=""` will render the default icon. @@ -79,7 +79,7 @@ Using a [paired shortcode](https://gohugo.io/content-management/shortcodes/) all ```md {{}} -This alert contains a **markdown** list and header: +This ***paired shortcode*** alert contains a **markdown** list and header: #### My Shopping List: 1. Tomatoes @@ -91,7 +91,7 @@ and a sentence styled using HTML tags such as \}} -This alert contains a **markdown** list and header: +This ***paired shortcode*** alert contains a **markdown** list and header: #### My Shopping List: 1. Tomatoes From f0ec772a294e680d2792422c747d9bf790f143f0 Mon Sep 17 00:00:00 2001 From: Colin Wilson Date: Tue, 22 Nov 2022 23:08:43 +0000 Subject: [PATCH 8/8] =?UTF-8?q?=F0=9F=8E=A8=20theme=20update=20?= =?UTF-8?q?=F0=9F=93=81=20content=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/feature-guide/shortcodes/alerts.md | 4 ++-- .../shortcodes}/tables-and-tabs.md | 6 +++--- content/docs/feature-guide/shortcodes/tables.md | 12 ------------ themes/lotusdocs | 2 +- 4 files changed, 6 insertions(+), 18 deletions(-) rename content/docs/{test_markdown => feature-guide/shortcodes}/tables-and-tabs.md (66%) delete mode 100644 content/docs/feature-guide/shortcodes/tables.md diff --git a/content/docs/feature-guide/shortcodes/alerts.md b/content/docs/feature-guide/shortcodes/alerts.md index 81c885c..5959a7c 100644 --- a/content/docs/feature-guide/shortcodes/alerts.md +++ b/content/docs/feature-guide/shortcodes/alerts.md @@ -2,7 +2,7 @@ weight: 220 title: "Alerts" icon: notification_important -description: "How to use Alert Shortcodes." +description: "How to use Alert Shortcodes to render custom page alerts in markdown." lead: "Alerts." date: 2022-11-22T13:42:31+00:00 lastmod: 2022-11-22T13:42:31+00:00 @@ -43,7 +43,7 @@ Additional alert contexts include `success`, `danger`, `warning`, `primary`, `li {{< alert context="warning" text="This is an alert with a warning context. It consists of the warning theme colour and icon." />}} -{{< alert context="primary" text="This is an alert with a primary context. Its theme and icon color are that of the current primary theme colour." />}} +{{< alert context="primary" text="This is an alert with a primary context. Its theme and icon colors match those of the current primary theme colour." />}} {{< alert context="light" text="This is an alert with a light context. It consists of the light theme colour. The light alert has no default icon." />}} diff --git a/content/docs/test_markdown/tables-and-tabs.md b/content/docs/feature-guide/shortcodes/tables-and-tabs.md similarity index 66% rename from content/docs/test_markdown/tables-and-tabs.md rename to content/docs/feature-guide/shortcodes/tables-and-tabs.md index d7890a7..d357c31 100644 --- a/content/docs/test_markdown/tables-and-tabs.md +++ b/content/docs/feature-guide/shortcodes/tables-and-tabs.md @@ -1,13 +1,13 @@ --- +weight: 240 title: "Tables & Tabs" icon: table_chart -description: "A demonstration of how Lotus Docs creates and renders table & tabs" -lead: "An example markdown page for testing purposes." +description: "How to use Lotus Docs tables & tabs shortcodes to render great looking markdown tables and tabs" +lead: "Using Hugo shortcodes to render tables and tabs." date: 2022-11-05T04:41:15+00:00 lastmod: 2022-11-05T04:41:15+00:00 draft: true images: [] -weight: 10040 toc: true --- diff --git a/content/docs/feature-guide/shortcodes/tables.md b/content/docs/feature-guide/shortcodes/tables.md deleted file mode 100644 index db2d5d0..0000000 --- a/content/docs/feature-guide/shortcodes/tables.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -weight: 240 -title: "Tables" -icon: table_chart -description: "Table Shortcodes." -lead: "Tables." -date: 2022-11-22T12:45:31+00:00 -lastmod: 2022-11-22T12:45:31+00:00 -draft: true -images: [] -toc: true ---- \ No newline at end of file diff --git a/themes/lotusdocs b/themes/lotusdocs index 05da801..7ce0e24 160000 --- a/themes/lotusdocs +++ b/themes/lotusdocs @@ -1 +1 @@ -Subproject commit 05da8018e087ccbd628fa17293245408daee9b66 +Subproject commit 7ce0e24fc79c197661019a182fc583bd5e5fab52