From f01c46b8b33862b1995e6f9b8778bcd0208e974b Mon Sep 17 00:00:00 2001 From: saberzero1 Date: Wed, 25 Feb 2026 16:07:11 +0100 Subject: [PATCH] docs: update README for v5 unified config system --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 95dc6f6..51d9658 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,24 @@ npx quartz plugin add github:quartz-community/content-meta ## Usage -```ts -// quartz.layout.ts -import * as Plugin from "./.quartz/plugins"; +```yaml title="quartz.config.yaml" +plugins: + - source: github:quartz-community/content-meta + enabled: true + layout: + position: beforeBody + priority: 20 +``` -// Add to your layout -Plugin.ContentMeta(); // in the appropriate layout section +For advanced use cases, you can override in TypeScript: + +```ts title="quartz.ts (override)" +import * as ExternalPlugin from "./.quartz/plugins"; + +ExternalPlugin.ContentMeta({ + showReadingTime: true, + showComma: true, +}); ``` ## Configuration @@ -27,7 +39,7 @@ Plugin.ContentMeta(); // in the appropriate layout section ## Documentation -See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information. +See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/ContentMeta) for more information. ## License