mirror of
https://github.com/quartz-community/content-index.git
synced 2026-11-16 23:53:40 +00:00
Quartz's default content index plugin.
- TypeScript 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@quartz-community/content-index
Generates a sitemap, RSS feed, and content index JSON for full-text search.
Important
Built into Quartz 5.1+. The content index, sitemap and RSS feed are part of Quartz core now, configured under
configuration.contentIndexinquartz.config.yaml— you don't need this plugin anymore. Existing config entries for it keep working (Quartz applies their options to the built-in and doesn't load this package); runnpx quartz plugin doctor --fixto update your config. See Built-in processing. This package is kept for Quartz versions before 5.1.
Installation
npx quartz plugin add github:quartz-community/content-index
Usage
plugins:
- source: github:quartz-community/content-index
enabled: true
options:
enableSiteMap: true
enableRSS: true
For advanced use cases, you can override in TypeScript:
import * as ExternalPlugin from "./.quartz/plugins";
ExternalPlugin.ContentIndex({
enableSiteMap: true,
enableRSS: true,
rssLimit: 10,
rssFullHtml: false,
rssSlug: "index",
includeEmptyFiles: true,
});
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
enableSiteMap |
boolean |
true |
Whether to generate a sitemap.xml file. |
enableRSS |
boolean |
true |
Whether to generate an RSS feed. |
rssLimit |
number |
10 |
Maximum number of items to include in the RSS feed. |
rssFullHtml |
boolean |
false |
Whether to include full HTML content in the RSS feed. |
rssSlug |
string |
"index" |
The slug for the RSS feed file. |
includeEmptyFiles |
boolean |
true |
Whether to include empty files in the content index. |
Documentation
See the Quartz documentation for more information.
License
MIT