Skip to content

Commit

Permalink
fix(explorer): display names for folders without frontmatter (jackyzh…
Browse files Browse the repository at this point in the history
…a0#494)

* fix(explorer): display name for folders without `index` file

* docs(explorer): add section for folder display names
  • Loading branch information
benschlegel authored Sep 21, 2023
1 parent dcdeae4 commit 8eb1554
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/features/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Quartz features an explorer that allows you to navigate all files and folders on

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]]). 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.
>
Expand Down
5 changes: 4 additions & 1 deletion quartz/components/ExplorerNode.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ export class FileNode {
if (file.path[0] !== "index.md") {
this.children.push(new FileNode(file.file.frontmatter!.title, file.file, this.depth + 1))
} else {
this.displayName = file.file.frontmatter!.title
const title = file.file.frontmatter?.title
if (title && title !== "index" && file.path[0] === "index.md") {
this.displayName = title
}
}
} else {
const next = file.path[0]
Expand Down

0 comments on commit 8eb1554

Please sign in to comment.