User guide: adding instructions on how to use and update docsy as hug…

…o module (#802)

* User guide: adding instructions on how to use and update docsy as hugo module

* Add section on how to work around a known bug in Go's module management

* Docu for conversion of existing site: improvements and fixes

* User guide: reflect latest changes in hugo module implementation

* Add warning about order of sections [language] and [module] in config.toml

* Update docu to reflect changes made in e444964.

* Update _index.md

* Update _index.md

* Update installation-prerequisites.md

* Update _index.md

* Update example-site-as-template.md

* Update start-from-scratch.md

* Update start-from-scratch.md

* Update and rename quickstart-clone-git-repo.md to docsy-as-submodule

* Update _index.md

* Update start-from-scratch.md

* Rename docsy-as-submodule to other-options

* Rename other-options to other-options.md

* Create basic-configuration.md

* Update example-site-as-template.md

* Update start-from-scratch.md

* Update other-options.md

* Update basic-configuration.md

* Update quickstart-docker.md

* Update _index.md

* Update Updating-hugo-module.md

* Update _index.md

* Update Updating-submodules.md

* Update _index.md

* Update Convert-site-to-module.md

* Update Updating-submodules.md

* Update Updating-submodules.md

* Correct links to pre-release version 0.2.0-pre

* Netlify: correcting go version

* Compactify menu

...as left nav is getting very big...

* Fixed broken link to setup guide

* User guide, .gitignore: remove unneeded entry

Co-authored-by: LisaFC <lcarey@google.com>

netlify.toml

@@ -6,7 +6,7 @@ publish = "userguide/public"
 command = "npm run docs-install && npm run build:preview"
 
 [build.environment]
-GO_VERSION = "1.17.7"
+GO_VERSION = "1.18"
 HUGO_THEME = "repo"
 
 [context.production]

package.json

@@ -17,6 +17,6 @@
     "bootstrap": "^4.6.1"
   },
   "devDependencies": {
-    "hugo-extended": "0.93.2"
+    "hugo-extended": "0.96.0"
   }
 }

userguide/config.toml

@@ -132,7 +132,7 @@ prism_syntax_highlighting = false
 # User interface configuration
 [params.ui]
 # Enable to show the side bar menu in its compact state.
-sidebar_menu_compact = false
+sidebar_menu_compact = true
 sidebar_menu_foldable = false
 sidebar_cache_limit = 10
 # Set to true to disable breadcrumb navigation.

userguide/content/en/docs/Adding content/Shortcodes/index.md

@@ -361,7 +361,7 @@ Karibu sana!
 
 Tabbed panes are implemented using two shortcodes:
 
-* The `tabpane` shortcode, which is the container element for the tabs. This shortcode can optionally held the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code blocks of the individual tabs. In case the header text of the tab equals the `language` used in the tab's code block (as in the first tabbed pane example above), you may specify `langEqualsHeader=true` in the surrounding `tabpane` shortcode. Then, the header text of the individual tab is automatically set as `language` parameter of the respective tab.
+* The `tabpane` shortcode, which is the container element for the tabs. This shortcode can optionally hold the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code blocks of the individual tabs. In case the header text of the tab equals the `language` used in the tab's code block (as in the first tabbed pane example above), you may specify `langEqualsHeader=true` in the surrounding `tabpane` shortcode. Then, the header text of the individual tab is automatically set as `language` parameter of the respective tab.
 * The various `tab` shortcodes which actually represent the tabs you would like to show. We recommend specifying the named parameter `header` for each text in order to set the header text of each tab. If needed, you can additionally specify the named parameters `lang` and `highlight` for each tab. This allows you to overwrite the settings given in the parent `tabpane` shortcode. If the language is neither specified in the `tabpane` nor in the `tab`shortcode, it defaults to Hugo's site variable `.Site.Language.Lang`.
 
 ## Card panes
@@ -386,7 +386,7 @@ When authoring content, it's sometimes very useful to put similar text blocks or
 Docsy supports creating such card panes via different shortcodes:
 
 * The `cardpane` shortcode which is the container element for the various cards to be presented.
-* The `card` shortcodes, with each shortcode representing an individual card. While cards are often presented inside a card group, a single card may stand on its own, too. A `card` shortcode can held text, images or any other arbitrary kind of markdown or HTML markup as content. If your content is programming code, you are advised to make use of the `card-code` shortcode, a special kind of card with code-highlighting and other optional features like line numbers, highlighting of certain lines, ….
+* The `card` shortcodes, with each shortcode representing an individual card. While cards are often presented inside a card group, a single card may stand on its own, too. A `card` shortcode can hold text, images or any other arbitrary kind of markdown or HTML markup as content. If your content is programming code, you are advised to make use of the `card-code` shortcode, a special kind of card with code-highlighting and other optional features like line numbers, highlighting of certain lines, ….
 
 ### Shortcode `card` (for text, images, …)
 
@@ -459,7 +459,7 @@ int main(void)
 }
 {{< /card-code >}}
 
-<br/>The `card-code` shortcode can optionally held the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code block presented on the card.
+<br/>The `card-code` shortcode can optionally hold the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code block presented on the card.
 
 ### Card groups
 

userguide/content/en/docs/Deployment/_index.md

@@ -56,7 +56,7 @@ Then follow the instructions in [Host on Netlify](https://gohugo.io/hosting-and-
    1. For your **Build command**, specify `cd themes/docsy && git submodule update -f --init && cd ../.. && hugo`. You need to specify this rather than just `hugo` so that Netlify can use the theme's submodules. If you don't want your site to be indexed by search engines, you can add an environment flag to specify a non-`production` environment, as described in [Build environments and indexing](#build-environments-and-indexing).
    1. Click **Show advanced**. 
    1. In the **Advanced build settings** section, click **New variable**. 
-   1. Specify `HUGO_VERSION` as the **Key** for the new variable, and `0.53` or later as its **Value**. 
+   1. Specify `HUGO_VERSION` as the **Key** for the new variable, and `0.73` or later as its **Value**. 
 1. Click **Deploy site**.
 
 {{% alert title="Note" color="primary" %}}