From e67f409ec1fa36779f59a635eb3e16408275575d Mon Sep 17 00:00:00 2001
From: Ben Schlegel <31989404+benschlegel@users.noreply.github.com>
Date: Sun, 17 Sep 2023 19:36:04 +0000
Subject: [PATCH] Merge pull request #479 from benschlegel/explorer-config
---
docs/features/explorer.md | 18 ++++++------------
1 files changed, 6 insertions(+), 12 deletions(-)
diff --git a/docs/features/explorer.md b/docs/features/explorer.md
index 76d04c6..cb63e40 100644
--- a/docs/features/explorer.md
+++ b/docs/features/explorer.md
@@ -145,25 +145,19 @@
### Remove list of elements (`filter`)
-Using this example, you can remove elements from your explorer by providing a list of folders/files using the `list` array.
+Using this example, you can remove elements from your explorer by providing an array of folders/files using the `omit` set.
```ts title="quartz.layout.ts"
Component.Explorer({
filterFn: (node) => {
- // list containing names of everything you want to filter out
- const list = ["authoring content", "building your", "tags", "hosting"]
-
- for (let listNodeName of list) {
- if (listNodeName.toLowerCase() === node.name.toLowerCase()) {
- return false // Found a match, so return false to filter out the node
- }
- }
- return true // No match found, so return true to keep the node
+ // set containing names of everything you want to filter out
+ const omit = new Set(["authoring content", "tags", "hosting"])
+ return omit.has(node.name.toLowerCase())
},
})
```
-You can customize this by changing the entries of the `list` array. Simply add all folder or file names you want to remove to the array (case insensitive).
+You can customize this by changing the entries of the `omit` set. Simply add all folder or file names you want to remove.
## Advanced examples
@@ -224,7 +218,7 @@
> You can then import them like this:
>
> ```ts title="quartz.layout.ts"
-> import { mapFn, filterFn, sortFn } from "./path/to/your/functions"
+> import { mapFn, filterFn, sortFn } from "./functions.ts"
> Component.Explorer({
> mapFn: mapFn,
> filterFn: filterFn,
--
Gitblit v1.10.0