smyalygames/quartz
Template
1
0
Fork 0
mirror of https://github.com/jackyzha0/quartz.git synced 2025-05-18 06:24:22 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updating breadcrumbs docs on ConditionalRender (#1871)
Some checks failed
Build and Test / build-and-test (ubuntu-latest) (push) Has been skipped
Details
Build and Test / publish-tag (push) Has been skipped
Details
Build and Test / build-and-test (macos-latest) (push) Has been cancelled
Details
Build and Test / build-and-test (windows-latest) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Stephen Tse 2025-03-26 08:32:13 -07:00 committed by GitHub
parent 23b691f38c
commit b397dae951
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/features/breadcrumbs.md
View File

@ -19,7 +19,6 @@ Component.Breadcrumbs({
spacerSymbol: "❯", // symbol between crumbs spacerSymbol: "❯", // symbol between crumbs
rootName: "Home", // name of first/root element rootName: "Home", // name of first/root element
resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles
hideOnRoot: true, // whether to hide breadcrumbs on root `index.md` page
showCurrentPage: true, // whether to display the current page in the breadcrumbs showCurrentPage: true, // whether to display the current page in the breadcrumbs
}) })
``` ```

11
docs/layout-components.md
View File

@ -81,4 +81,13 @@ Component.ConditionalRender({
}) })
``` ```
This example would only render the Search component when the page is not in fullpage mode. The example above would only render the Search component when the page is not in fullpage mode.
```typescript
Component.ConditionalRender({
component: Component.Breadcrumbs(),
condition: (page) => page.fileData.slug !== "index",
})
```
The example above would hide breadcrumbs on the root `index.md` page.