Initial commit

docs/plugins/FolderPage.md

@@ -0,0 +1,22 @@
+---
+title: FolderPage
+tags:
+  - plugin/emitter
+---
+
+This plugin generates index pages for folders, creating a listing page for each folder that contains multiple content files. See [[folder and tag listings]] for more information.
+
+Example: [[advanced/|Advanced]]
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+The pages are displayed using the `defaultListPageLayout` in `quartz.layouts.ts`. For the content, the `FolderContent` component is used. If you want to modify the layout, you must edit it directly (`quartz/components/pages/FolderContent.tsx`).
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.FolderPage()`.
+- Source: [`quartz/plugins/emitters/folderPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/folderPage.tsx).