⚙️ config update

config.toml

@@ -4,6 +4,7 @@ title = "Lotus Docs"
 theme = "lotusdocs"
 contentDir = "content"
 enableEmoji = true
+enableGitInfo = true # N.B. .GitInfo does not currently function with submodule content directories
 
 [module]
   # uncomment line below for temporary local development of module
@@ -15,26 +16,47 @@ enableEmoji = true
     path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5"
     disable = false
 
+[markup]
+  defaultMarkdownHandler = "goldmark"
+  [markup.goldmark]
+    [markup.goldmark.renderer]
+      unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/
+
 [params]
 
   # google_fonts = [
-  #   ["Nunito", "300, 400, 600, 700"],
+  #   ["Nunito Sans", "300, 400, 600, 700"],
   #   ["Source Code Pro", "500, 700"]
   # ]
 
-  # sans_serif_font = "Nunito"          # Default is System font
-  # secondary_font  = "Nunito"          # Default is System font
+  # sans_serif_font = "Nunito Sans"     # Default is System font
+  # secondary_font  = "Nunito Sans"     # Default is System font
   # mono_font       = "Source Code Pro" # Default is System font
 
     [params.footer]
         copyright = "© :YEAR: Lotus Labs. Designed by Colin Wilson"
         version = true # includes git commit info
 
     [params.social]
-            github = "colinwilson/lotusdocs"        # github.com/YOUR_GITHUB_ID
-            twitter = "lotusdocs"       # twitter.com/YOUR_TWITTER_ID
-            # instagram = "colinwilson"     # instagram.com/YOUR_INSTAGRAM_ID
-            # rss = true                    # show rss icon with link
+        github = "colinwilson/lotusdocs"        # github.com/YOUR_GITHUB_ID
+        twitter = "lotusdocs"       # twitter.com/YOUR_TWITTER_ID
+        # instagram = "colinwilson"     # instagram.com/YOUR_INSTAGRAM_ID
+        # rss = true                    # show rss icon with link
+
+    [params.docs] # Parameter fo the /docs 'template'
+        title         = "Lotus Labs Documentation"  # default html title for documentation pages/sections
+        breadcrumbs   = true                        # default is true
+        backToTop     = true                        # enable back-to-top button? default true
+
+        toc           = true                        # enable table of contents? default is true
+        scrollSpy     = true                        # enable scrollspy on ToC? default is true
+
+        descriptions  = true                        # enable front matter descriptions under content title?
+        titleIcon     = true                        # enable front matter icon title prefix? default is false
+        navDesc       = true                        # include front matter descriptions in Prev/Next navigation cards
+        navDescTrunc  = 30                          # Number of characters by which to truncate the Prev/Next descriptions
+
+        listDescTrunc = 100                         # Number of characters by which to truncate the list card description
 
 [menu]
 # [[menu.primary]]

content/docs/_index.md

@@ -1,10 +1,11 @@
 ---
-title : "Lotus Docs"
-description: "Documentation for the Lotus Docs Hugo Theme."
-date: 2022-10-24T03:28:23+00:00
-lastmod: 2022-10-24T03:28:23+00:00
+weight: 10
+title: "Lotus Docs Documentation"
+description: "Explore our guides and examples to deploy your docs using Lotus Docs."
+icon: menu_book
+lead: ""
+date: 2022-10-10T02:21:15+00:00
+lastmod: 2022-10-10T02:21:15+00:00
 draft: false
 images: []
----
-
-## Hello World
+---

content/docs/contributing/_index.md

@@ -0,0 +1,11 @@
+---
+weight: 400
+title: "Contributing"
+description: "Find out how to contribute to Lotus Labs."
+icon: heart_plus
+lead: ""
+date: 2022-10-15T02:21:15+00:00
+lastmod: 2022-10-15T02:21:15+00:00
+draft: false
+images: []
+---

content/docs/contributing/code-of-conduct.md

@@ -0,0 +1,142 @@
+---
+title: "Code of Conduct"
+icon: handshake
+description: "Contributor Covenant Code of Conduct."
+lead: "Contributor Covenant Code of Conduct."
+date: 2022-10-15T02:21:15+00:00
+lastmod: 2022-10-15T02:21:15+00:00
+draft: false
+images: []
+weight: 430
+toc: true
+---
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behaviour that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behaviour include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behaviour and will take appropriate and fair corrective action in
+response to any behaviour that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the project team at lotusdocs@aigis.uk.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behaviour deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behaviour was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behaviour. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behaviour.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behaviour, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

content/docs/contributing/financial-contributions.md

@@ -0,0 +1,36 @@
+---
+title: "Financial Contributions"
+icon: paid
+description: "Help support the Lotus Labs development team by becoming a financial contributor."
+lead: "Help support the Lotus Labs development team by becoming a financial contributor."
+date: 2022-10-19T07:07:38+01:00
+lastmod: 2022-10-19T07:07:38+01:00
+draft: true
+images: []
+weight: 420
+toc: true
+---
+
+We use [Open Collective](https://opencollective.com/) to receive contributions, share our budget, and manage expenses. Visit the [Doks Open Collective page](https://opencollective.com/doks).
+
+## Become a Sponsor
+
+Become a sponsor starting at $100.00 per month. Your logo — with a link to your website — will show up on the [Doks website](https://getdoks.org/), the [Doks repository](https://github.com/h-enk/doks), and the [Doks Open Collective page](https://opencollective.com/doks).
+
+[![Become a Sponsor](contribute-button.png)](https://opencollective.com/doks/contribute/sponsor-31303/checkout)
+
+## Become a Backer
+
+Become a backer starting at $5.00 per month. Your avatar will show up on the [Doks repository](https://github.com/h-enk/doks) and the [Doks Open Collective page](https://opencollective.com/doks).
+
+[![Become a Backer](contribute-button.png)](https://opencollective.com/doks/contribute/backer-31302/checkout)
+
+## Make a Donation
+
+Make a custom one-time or recurring contribution.
+
+[![Make a Donation](contribute-button.png)](https://opencollective.com/doks/donate)
+
+## Thanks :green_heart:
+
+Thanks for your contribution!

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

@@ -0,0 +1,47 @@
+---
+title: "How to Contribute"
+icon: volunteer_activism
+description: "Contribute to code, improve documentation, help others, submit to showcase, and contribute financially."
+lead: "Contribute to code, improve documentation, help others, submit to showcase, and contribute financially."
+date: 2022-10-19T21:49:38+01:00
+lastmod: 2022-10-19T21:49:38+01:00
+draft: true
+images: []
+weight: 410
+toc: true
+---
+
+## Contribute to code
+
+### Create an issue
+
+- [Bug report](https://github.com/h-enk/doks/issues/new?template=bug-report---.md)
+- [Feature request](https://github.com/h-enk/doks/issues/new?template=feature-request---.md)
+
+### Create a Pull Request
+
+- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
+- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
+
+## Improve documentation
+
+
+- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
+- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
+
+### Create an issue
+
+- [Bug report](https://github.com/h-enk/getdoks.org/issues/new?template=bug-report---.md)
+- [Feature request](https://github.com/h-enk/getdoks.org/issues/new?template=feature-request---.md)
+
+## Help others
+
+[Doks Discussions](https://github.com/h-enk/doks/discussions) is the place to get help and help others with Doks.
+
+## Submit to showcase
+
+[Share what you’ve built with us](https://github.com/h-enk/doks/discussions?discussions_q=category%3A%22Show+and+tell%22).
+
+## Contribute financially
+
+Help support the team developing Doks by [becoming a financial contributor](/docs/contributing/financial-contributions/).

content/docs/get-started.md

@@ -0,0 +1,50 @@
++++
+weight = 200
+date = "2022-09-30T05:34:22+01:00"
+draft = true
+author = "Colin Wilson"
+title = "Get started"
+icon = "rocket_launch"
+# featured_image = ""
+description = "Get started with Lotus Docs"
+publishdate = "2022-09-30T05:34:22+01:00"
+tags = ["Beginners","Guide"]
+categories = [""]
+
+[twitter]
+  card = "summary"
+  site = "@LotusDocs"
+  creator = "@LotusDocs"
+  title = "Getting started"
+  description = "Getting started with Lotus Docs"
+  image = ""
+
++++
+
+## Account Sign Up
+
+One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin.
+
+## My Heading
+
+He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment.
+
+### My Subheading
+
+Doubtful it stood;
+As two spent swimmers, that do cling together
+And choke their art. The merciless Macdonwald--
+Worthy to be a rebel, for to that
+The multiplying villanies of nature
+Do swarm upon him--from the western isles
+Of kerns and gallowglasses is supplied;
+And fortune, on his damned quarrel smiling,
+Show'd like a rebel's whore: but all's too weak:
+For brave Macbeth--well he deserves that name--
+Disdaining fortune, with his brandish'd steel,
+Which smoked with bloody execution,
+Like valour's minion carved out his passage
+Till he faced the slave;
+Which ne'er shook hands, nor bade farewell to him,
+Till he unseam'd him from the nave to the chaps,
+And fix'd his head upon our battlements.

content/docs/help/FAQs.md

@@ -0,0 +1,12 @@
+---
+title: "FAQ"
+icon: "quiz"
+description: "Answers to frequently asked questions."
+lead: "Answers to frequently asked questions."
+date: 2020-10-06T08:49:31+00:00
+lastmod: 2020-10-06T08:49:31+00:00
+draft: false
+images: []
+weight: 520
+toc: true
+---