fix: rework hideBreadcrumbs param to breadcrumbs; update docs accordi…

…ngly
imfing · Apr 22, 2024 · 7a0cdf8 · 7a0cdf8
1 parent 9e2c014
commit 7a0cdf8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/exampleSite/content/docs/guide/organize-files.md b/exampleSite/content/docs/guide/organize-files.md
@@ -84,7 +84,7 @@ weight: 2
 
 ## Breadcrumb Navigation
 
-Breadcrumbs are auto-generated based on the directory structure of `/content`. 
+Breadcrumbs are auto-generated based on the directory structure of `/content`.
 
 For example, consider the file structure [demonstrated above](#directory-structure). Given that structure, the breadcrumbs atop the page at `/docs/guide/organize-files/` would appear automatically as follows:
 
@@ -112,11 +112,11 @@ Documentation > Guide > Foo Bar
 
 ### Hiding Breadcrumbs
 
-You can hide breadcrumbs completely from a page by specfying `hideBreadcrumbs: true` in its front matter:
+You can hide breadcrumbs completely from a page by specfying `breadcrumbs: false` in its front matter:
 
 ```yaml {filename="content/docs/guide/organize-files.md"}
 ---
-hideBreadcrumbs: true
+breadcrumbs: false
 title: Organize Files
 ---
 ```

diff --git a/layouts/partials/breadcrumb.html b/layouts/partials/breadcrumb.html
@@ -1,4 +1,4 @@
-{{- if not (default false .Params.hideBreadcrumbs) }}
+{{- if (default true .Params.breadcrumbs) }}
   <div class="hx-mt-1.5 hx-flex hx-items-center hx-gap-1 hx-overflow-hidden hx-text-sm hx-text-gray-500 dark:hx-text-gray-400 contrast-more:hx-text-current">
     {{- range .Ancestors.Reverse }}
       {{- if not .IsHome }}
@@ -12,4 +12,4 @@
       {{- partial "utils/title" . -}}
     </div>
   </div>
-{{ end -}}
+{{ end -}}