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

2
docs/plugins/ContentIndex.md
View File

@@ -17,7 +17,7 @@ This plugin accepts the following configuration options:
- `enableSiteMap`: If `true` (default), generates a sitemap XML file (`sitemap.xml`) listing all site URLs for search engines in content discovery. - `enableSiteMap`: If `true` (default), generates a sitemap XML file (`sitemap.xml`) listing all site URLs for search engines in content discovery.
- `enableRSS`: If `true` (default), produces an RSS feed (`index.xml`) with recent content updates. - `enableRSS`: If `true` (default), produces an RSS feed (`index.xml`) with recent content updates.
- `rssLimit`: Defines the maximum number of entries to include in the RSS feed, helping to focus on the most recent or relevant content. Defaults to `10`. - `rssLimit`: Defines the maximum number of entries to include in the RSS feed, helping to focus on the most recent or relevant content. Defaults to `10`.
- `rssFullHtml`: If `true`, the RSS feed includes full HTML content. Otherwise it includes just summaries. - `rssFullHtml`: If `true`, the RSS feed includes the full rendered HTML content of each page. Defaults to `false`.
- `rssSlug`: Slug to the generated RSS feed XML file. Defaults to `"index"`. - `rssSlug`: Slug to the generated RSS feed XML file. Defaults to `"index"`.
- `includeEmptyFiles`: If `true` (default), content files with no body text are included in the generated index and resources. - `includeEmptyFiles`: If `true` (default), content files with no body text are included in the generated index and resources.

2
docs/plugins/CustomOgImages.md
View File

@@ -60,6 +60,8 @@ ExternalPlugin.CustomOgImages({
| `width` | number | 1200 | Width of the generated image in pixels | | `width` | number | 1200 | Width of the generated image in pixels |
| `height` | number | 630 | Height 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 | | `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 | | `imageStructure` | component | defaultImage | Custom component to use for image generation |
## Frontmatter Properties ## Frontmatter Properties