From 184edb168153338ea9dfb0acd689488d98b12ca6 Mon Sep 17 00:00:00 2001 From: saberzero1 Date: Wed, 25 Feb 2026 16:07:03 +0100 Subject: [PATCH] docs: update README for v5 unified config system --- README.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e159544..92ce124 100644 --- a/README.md +++ b/README.md @@ -10,28 +10,21 @@ npx quartz plugin add github:quartz-community/folder-page ## Usage -```ts -// quartz.config.ts -import * as ExternalPlugin from "./.quartz/plugins"; - -const config: QuartzConfig = { - plugins: { - pageTypes: [ExternalPlugin.FolderPage()], - }, -}; +```yaml title="quartz.config.yaml" +plugins: + - source: github:quartz-community/folder-page + enabled: true ``` -```ts -// quartz.layout.ts -export const layout = { - byPageType: { - folder: { - beforeBody: [...], - left: [...], - right: [...], - }, - }, -} +For advanced use cases, you can override in TypeScript: + +```ts title="quartz.ts (override)" +import * as ExternalPlugin from "./.quartz/plugins"; + +ExternalPlugin.FolderPage({ + showFolderCount: true, + showSubfolders: true, +}); ``` ## Configuration @@ -44,7 +37,7 @@ export const layout = { ## Documentation -See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information. +See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/FolderPage) for more information. ## License