From 259d0a6d9ac5a02f0281e3fc061861b23481348f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 11 Aug 2023 07:31:44 +0000
Subject: [PATCH] more documentation

---
 content/features/folder and tag listings.md |   28 ++++++++++++++++++++++++++++
 1 files changed, 28 insertions(+), 0 deletions(-)

diff --git a/content/features/folder and tag listings.md b/content/features/folder and tag listings.md
index e69de29..caad796 100644
--- a/content/features/folder and tag listings.md
+++ b/content/features/folder and tag listings.md
@@ -0,0 +1,28 @@
+---
+title: Folder and Tag Listings
+tags:
+  - plugin/emitter
+---
+
+Quartz creates listing pages for any folders and tags you have.
+
+## Folder Listings
+
+Quartz will generate an index page for all the pages under that folder. This includes any content that is multiple levels deep.
+
+Additionally, Quartz will also generate pages for subfolders. Say you have a note in a nested folder `content/abc/def/note.md`. Then, Quartz would generate a page for all the notes under `abc` _and_ a page for all the notes under `abc/def`.
+
+By default, Quartz will title the page `Folder: <name of folder>` and no description. You can override this by creating an `index.md` file in the folder with the `title` [[authoring content#Syntax|frontmatter]] field. Any content you write in this file will also be used in the description of the folder.
+
+## Tag Listings
+
+Quartz will also create an index page for each unique tag in your vault and render a list of all notes with that tag.
+
+Quartz also supports tag hierarchies as well (e.g. `plugin/emitter`) and will also render a separate tag page for each layer of the tag hierarchy. It will also create a default global tag index page at `/tags` that displays a list of all the tags in your Quartz.
+
+## Customization
+
+The layout for both the folder and content pages can be customized. By default, they use the `defaultListPageLayout` in `quartz.layouts.ts`. If you'd like to make more involved changes to the layout and don't mind editing some [[creating components|Quartz components]], you can take a look at `quartz/components/pages/FolderContent.tsx` and `quartz/components/pages/TagContent.tsx` respectively.
+
+- Removing folder listings: remove `Plugin.FolderPage()` from `emitters` in `quartz.config.ts`
+- Removing tag listings: remove `Plugin.TagPage()` from `emitters` in `quartz.config.ts`

--
Gitblit v1.10.0