zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add missing options to emitter plugin documentation

Browse Source 
- ContentIndex: clarify rssFullHtml default
- CustomOgImages: add defaultTitle and defaultDescription options
This commit is contained in:
saberzero1
2026-05-22 20:07:48 +02:00
parent 05b79e1d60
commit afb84b1ffe
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/plugins/CustomOgImages.md
View File

@@ -59,8 +59,10 @@ ExternalPlugin.CustomOgImages({
| `colorScheme` | string | "lightMode" | Theme to use for generating images ("darkMode" or "lightMode") |
| `width` | number | 1200 | Width of the generated image in pixels |
| `height` | number | 630 | Height of the generated image in pixels |
| `excludeRoot` | boolean | false | Whether to exclude the root index page from auto-generated images |
| `imageStructure` | component | defaultImage | Custom component to use for image generation |
| `excludeRoot` | boolean | false | Whether to exclude the root index page from auto-generated images |
| `defaultTitle` | string | "Untitled" | Fallback title when a page has no title |
| `defaultDescription`| string | "No description provided"| Fallback description when a page has no description |
| `imageStructure` | component | defaultImage | Custom component to use for image generation |
## Frontmatter Properties