From 0b75c1c5b4755e2ae30befd084e5f7ba7900236c Mon Sep 17 00:00:00 2001 From: Casey Smith Date: Tue, 17 Jan 2023 09:01:50 -0500 Subject: [PATCH 1/2] Enables Breadcrumb nav and adds comments to config file --- mkdocs.yml | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2eae1dac1..01d2368b6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,17 +39,18 @@ theme: - content.tooltips #enables enhanced tooltips - content.tabs.link #links tabs with the same name, so when one is clicked, the others on the same page focus on matching tabs # - header.autohide - # - navigation.expand - - navigation.instant - - navigation.indexes - - navigation.sections - - navigation.tabs + # - navigation.expand #expands everything in nav. Not enabled intentionally it's really overwhelming. + - navigation.instant #makes site act like a SPA. Preserves search index on navigation and saves a bunch of time. Keeps site snappy. + - navigation.path # enables breadcrumbs + - navigation.indexes # enables attaching a page to section head: the "index" pages + - navigation.sections # top-level sections are rendered in groups in the sidebar + - navigation.tabs # adds the top level menu tabs in the header bar. # - navigation.tabs.sticky - - navigation.top - - navigation.tracking - - search.highlight - - search.share - - search.suggest + - navigation.top #back to top button + - navigation.tracking # URL in the address bar is automatically updated with the active anchor as highlighted in the table of contents. + - search.highlight # highlights search term on page + - search.share # allows users to share a deeplink to search results + - search.suggest # enables search suggestions # - toc.integrate #this is a really noisy feature, IMO. font: false # Prevents autoloading of google fonts, for privacy reasons. favicon: assets/favicon.ico From 435418605fff25280c139005f7df8ef11a45d91e Mon Sep 17 00:00:00 2001 From: Casey Smith Date: Tue, 17 Jan 2023 15:49:17 -0500 Subject: [PATCH 2/2] tiny change for new build --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 01d2368b6..590be7218 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,11 +35,11 @@ theme: - content.action.edit # adds edit icon to pages - content.action.view # adds view page source icon to pages #- announce.dismiss # this feature is perenially buggy, so keep it disabled unless necessary. - - content.code.annotate #enables code annotation feature + - content.code.annotate # enables code annotation feature - content.tooltips #enables enhanced tooltips - content.tabs.link #links tabs with the same name, so when one is clicked, the others on the same page focus on matching tabs # - header.autohide - # - navigation.expand #expands everything in nav. Not enabled intentionally it's really overwhelming. + # - navigation.expand # expands everything in nav. Not enabled intentionally it's really overwhelming. - navigation.instant #makes site act like a SPA. Preserves search index on navigation and saves a bunch of time. Keeps site snappy. - navigation.path # enables breadcrumbs - navigation.indexes # enables attaching a page to section head: the "index" pages