Quartz's default content index plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Emile Bangma a940cc613d
Merge pull request #8 from quartz-community/dev-mode/version-pr-ci
ci: run ci.yml on the changesets version PR and report it as a commit status
2026-11-09 04:01:54 +01:00
.changeset chore: version package 2026-11-09 02:13:26 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src refactor: import SimpleSlug from upstream types 2026-04-16 15:25:49 +02:00
test feat: respect file.data.unlisted and skip richContent for encrypted pages 2026-04-11 13:49:16 +02:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:53 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 23:35:13 +01:00
CHANGELOG.md chore: version package 2026-11-09 02:13:26 +00:00
LICENSE Initial commit 2026-02-13 23:35:13 +01:00
package-lock.json chore: version package 2026-11-09 02:13:26 +00:00
package.json chore: version package 2026-11-09 02:13:26 +00:00
README.md docs: note that this plugin is built into Quartz 5.1+ 2026-11-07 13:15:33 +01:00
tsconfig.json feat: respect file.data.unlisted and skip richContent for encrypted pages 2026-04-11 13:49:16 +02:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:33 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@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.contentIndex in quartz.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); run npx quartz plugin doctor --fix to 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