From c5b9137f12ea372d9196e41ffffc91eee7ad772e Mon Sep 17 00:00:00 2001
From: Vince Imbat <96913392+vinceimbat@users.noreply.github.com>
Date: Sat, 23 Sep 2023 02:39:02 +0000
Subject: [PATCH] docs: Adds Vince Imbat to showcase (#501)
---
docs/features/explorer.md | 14 +++++++++++++-
1 files changed, 13 insertions(+), 1 deletions(-)
diff --git a/docs/features/explorer.md b/docs/features/explorer.md
index b0eb12d..91766a9 100644
--- a/docs/features/explorer.md
+++ b/docs/features/explorer.md
@@ -8,6 +8,8 @@
By default, it shows all folders and files on your page. To display the explorer in a different spot, you can edit the [[layout]].
+Display names for folders get determined by the `title` frontmatter field in `folder/index.md` (more detail in [[authoring content | Authoring Content]]). If this file does not exist or does not contain frontmatter, the local folder name will be used instead.
+
> [!info]
> The explorer uses local storage by default to save the state of your explorer. This is done to ensure a smooth experience when navigating to different pages.
>
@@ -29,7 +31,7 @@
sortFn: (a, b) => {
... // default implementation shown later
},
- filterFn: undefined,
+ filterFn: filterFn: (node) => node.name !== "tags", // filters out 'tags' folder
mapFn: undefined,
// what order to apply functions in
order: ["filter", "map", "sort"],
@@ -160,6 +162,16 @@
You can customize this by changing the entries of the `omit` set. Simply add all folder or file names you want to remove.
+### Show every element in explorer
+
+To override the default filter function that removes the `tags` folder from the explorer, you can set the filter function to `undefined`.
+
+```ts title="quartz.layout.ts"
+Component.Explorer({
+ filterFn: undefined, // apply no filter function, every file and folder will visible
+})
+```
+
## Advanced examples
### Add emoji prefix
--
Gitblit v1.10.0