menu: make footer area configurable #1059

docs/content/authoring/frontmatter/reference/frontmatter.toml

@@ -166,15 +166,16 @@ collapsibleMenu = true
 # Menus are written from the sidebar's top to buttom in the order given in
 # these arrays. If not set, the set value of your site's hugo.toml is used.
 # Each entry can contain the following keys:
-# - `type` is mandatory. Either `page` in case it should generate a tre from
-#    the page structure or `menu` in case it should generate a tree from a
-#    defined menu.
+# - `type` is mandatory. Either `page` in case it should generate a tree from
+#    the page structure, `menu` in case it should generate a tree from a
+#    defined menu, `custom` for arbitrary HTML snippets or `divider` for a
+#    horizontal ruler.
 # - `identifier` is mandatory. In case of `type=page`, anything can be used,
 #    in case of `type=menu` the `identifier` key must be identical to the
 #    key of the menu definition.
 # - `main`, boolean. If `true`, the first tree level is spaced more generous
 #    and the text is emphasized. Default: `true` for `type=page` and `false`
-#    for `type=menu`
+#    for `type=menu` and `type=custom`
 # - `disableTitle`, boolean. If `true`, there is no title above the tree.
 #    Default: `true` for `type=page` and `false` for `type=menu`. If a title
 #    should be used, in case of `type=page` it will be taken from the page's
@@ -183,23 +184,34 @@ collapsibleMenu = true
 #    from the menu `title` according to Hugo's documentation and if not set
 #    from the menu `name` and if this is not set form the page's `linkTitle`.
 # - `pageRef`, optional. In case of `type=page` this is the starting page's
-#   path. If not set, the home page will be used.
+#    path. If not set, the home page will be used.
+# - `elements`, optional. In case of `type=custom` the list of elements to
+#    display. The theme shipps with the following predefined snippets which
+#    all accept the `icon` parameter to overwrite the default icon
+#    - languageswitcher: will display the language switcher
+#    - variantswitcher: will display the variant switcher
+#    - historyclearer: will display a button to clear the history of visited links
 
-# Define your own menus of the sidebar header.
+# The sidebar header menu.
 # Default: see notes
-# If not given, this accounts to the settings for disableLandingPageButton
-# and landingPageName. Otherwise you are free to define any menus as explained
-# above
-sidebarheadermenus = ""
+# If not given, defaults to
+# - a home button if configured; if you redefine this, use a Hugo menu and a type=menu to replicate this
+# - a divider to separate from the sidebarmenus (depending on the configuration of the theme variant)
+sidebarheadermenus = ''
 
-# Default: the value used below, but see the notes
-# The sidebar menus are built from this parameter. If not set, it contains
-# the below default. The default for the shortcut's disableTitle accounts
-# to the setting of disableShortcutsTitle.
-sidebarmenus = [
-	{ type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' },
-	{ type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false },
-]
+# The main sidebar header.
+# Default: see notes
+# - the main page menu based on your content structure
+# - the shortcuts menu including the title if configured
+sidebarmenus = ''
+
+# The main sidebar header.
+# Default: see notes
+# - a divider to separate from the sidebarmenus if any of the following is configured
+# - the language switcher if multilingual is configured
+# - the variant switcher if multiple variants are configured
+# - the history clearer if you configured to mark visited pages
+sidebarfootermenus = ''
 
 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # Hidden pages