Skip to content

Commit 7fe41d5

Browse files
authored
[docs] Update doc site to improve navigation (#4002)
* [docs] Update doc site to improve navigation This PR - Expands the left navigation menu - Includes a TOC for individual docs on the right - Includes breadcrumb links on top of the documents for faster nav-back to the root folder/any folder of the user's choice * Update website/config.toml
1 parent e470756 commit 7fe41d5

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

website/config.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,8 @@ algolia_docsearch = false
117117

118118
# User interface configuration
119119
[params.ui]
120-
# Enable to show the side bar menu in its compact state.
121-
sidebar_menu_compact = true
122-
# Set to true to disable breadcrumb navigation.
123-
breadcrumb_disable = true
120+
# Set to true to disable breadcrumb navigation.
121+
breadcrumb_disable = false
124122
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
125123
sidebar_search_disable = true
126124
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar

website/layouts/docs/baseof.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
1414
{{ partial "sidebar.html" . }}
1515
</div>
16-
16+
<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
17+
{{ partial "toc.html" . }}
18+
</div>
1719
<main class="col-12 col-md-9 col-xl-8 pl-md-5 of-docs__wrapper" role="main">
1820
{{ partial "version-banner.html" . }}
1921
{{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }}

0 commit comments

Comments
 (0)